| Version | Update Time | Status | Author | Description |
|---|---|---|---|---|
v2024-11-05 20:39:35 | 2024-11-05 20:39:35 | auto | @iteaj | Created by smart-doc |
1. 系统管理
1.1. 校验码功能
1.1.1. 生成code
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 生成code
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | string | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": ""
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/valid/code'1.1.2. 获取验证码
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取验证码
Response-example:
Return void.Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/valid/captcha'1.2. 后台用户管理中心
1.2.1. 修改用户
Type: POST
Content-Type: application/json
Description: 修改用户
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
sex | string | false | 性别 |
orgId | int64 | false | 所属部门 |
postId | int64 | false | 所属岗位 |
name | string | false | 用户昵称 |
string | false | 邮箱 | |
phone | string | false | 手机号 |
avatar | string | false | 用户头像 |
remark | string | false | 备注 |
account | string | false | 用户账号 |
status | enum | false | 用户状态(enabled, disabled) |
createTime | string | false | 创建时间 |
createBy | string | false | 创建人 |
updateTime | string | false | 更新时间 |
updateBy | string | false | 修改人 |
Request-body:
{
"id": 0,
"sex": "",
"orgId": 0,
"postId": 0,
"name": "",
"email": "",
"phone": "",
"avatar": "",
"remark": "",
"account": "",
"status": "enabled",
"createTime": "yyyy-MM-dd HH:mm:ss",
"createBy": "",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"updateBy": ""
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/center/editUser' --data '{
"id": 0,
"sex": "",
"orgId": 0,
"postId": 0,
"name": "",
"email": "",
"phone": "",
"avatar": "",
"remark": "",
"account": "",
"status": "enabled",
"createTime": "yyyy-MM-dd HH:mm:ss",
"createBy": "",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"updateBy": ""
}'1.2.2. 修改用户密码
Type: POST
Content-Type: application/json
Description: 修改用户密码
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | 用户唯一标识 |
oldPwd | string | false | 旧密码 |
password | string | false | 新密码 |
Request-body:
{
"id": 0,
"oldPwd": "",
"password": ""
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/center/pwd' --data '{
"id": 0,
"oldPwd": "",
"password": ""
}'1.3. 用户管理
1.3.1. 查询用户管理列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 查询用户管理列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
sex | string | false | 性别 | ||
orgId | int64 | false | 所属部门 | ||
postId | int64 | false | 所属岗位 | ||
name | string | false | 用户昵称 | ||
string | false | 邮箱 | |||
phone | string | false | 手机号 | ||
avatar | string | false | 用户头像 | ||
remark | string | false | 备注 | ||
account | string | false | 用户账号 | ||
status | enum | false | 用户状态(enabled, disabled) | ||
createTime | string | false | 创建时间 | ||
createBy | string | false | 创建人 | ||
updateTime | string | false | 更新时间 | ||
updateBy | string | false | 修改人 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/admin/view?size=0¤t=0&id=0&orgId=0&postId=0&status=enabled&createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&pages=0&isSearchCount=true&updateBy=&total=0&hitCount=true&optimizeCountSql=true&countId=&sex=&createBy=&name=&phone=&avatar=&remark=&maxLimit=0&email=&account='1.3.2. 新增用户及角色
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增用户及角色
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
sex | string | false | 性别 |
orgId | int64 | false | 所属部门 |
postId | int64 | false | 所属岗位 |
name | string | false | 用户昵称 |
string | false | 邮箱 | |
phone | string | false | 手机号 |
avatar | string | false | 用户头像 |
remark | string | false | 备注 |
account | string | false | 用户账号 |
status | enum | false | 用户状态(enabled, disabled) |
createTime | string | false | 创建时间 |
createBy | string | false | 创建人 |
updateTime | string | false | 更新时间 |
updateBy | string | false | 修改人 |
orgName | string | false | 所属部门 |
postName | string | false | 岗位名称 |
roleNames | string | false | 角色名称列表 |
roleIds | array | false | 角色列表 |
Request-body:
{
"id": 0,
"sex": "",
"orgId": 0,
"postId": 0,
"name": "",
"email": "",
"phone": "",
"avatar": "",
"remark": "",
"account": "",
"status": "enabled",
"createTime": "yyyy-MM-dd HH:mm:ss",
"createBy": "",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"updateBy": "",
"orgName": "",
"postName": "",
"roleNames": "",
"roleIds": [
0
]
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/admin/add' --data '{
"id": 0,
"sex": "",
"orgId": 0,
"postId": 0,
"name": "",
"email": "",
"phone": "",
"avatar": "",
"remark": "",
"account": "",
"status": "enabled",
"createTime": "yyyy-MM-dd HH:mm:ss",
"createBy": "",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"updateBy": "",
"orgName": "",
"postName": "",
"roleNames": "",
"roleIds": [
0
]
}'1.3.3. 获取用户详情
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取用户详情
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─sex | string | 性别 | - |
└─orgId | int64 | 所属部门 | - |
└─postId | int64 | 所属岗位 | - |
└─name | string | 用户昵称 | - |
string | 邮箱 | - | |
└─phone | string | 手机号 | - |
└─avatar | string | 用户头像 | - |
└─remark | string | 备注 | - |
└─account | string | 用户账号 | - |
└─status | enum | 用户状态(enabled, disabled) | - |
└─createTime | string | 创建时间 | - |
└─createBy | string | 创建人 | - |
└─updateTime | string | 更新时间 | - |
└─updateBy | string | 修改人 | - |
└─orgName | string | 所属部门 | - |
└─postName | string | 岗位名称 | - |
└─roleNames | string | 角色名称列表 | - |
└─roleIds | array | 角色列表 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"sex": "",
"orgId": 0,
"postId": 0,
"name": "",
"email": "",
"phone": "",
"avatar": "",
"remark": "",
"account": "",
"status": "enabled",
"createTime": "yyyy-MM-dd HH:mm:ss",
"createBy": "",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"updateBy": "",
"orgName": "",
"postName": "",
"roleNames": "",
"roleIds": [
0
]
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/admin/edit?id=0&=wj65vx'1.3.4. 修改用户及角色
Type: POST
Author: iteaj
Content-Type: application/json
Description: 修改用户及角色
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
sex | string | false | 性别 |
orgId | int64 | false | 所属部门 |
postId | int64 | false | 所属岗位 |
name | string | false | 用户昵称 |
string | false | 邮箱 | |
phone | string | false | 手机号 |
avatar | string | false | 用户头像 |
remark | string | false | 备注 |
account | string | false | 用户账号 |
status | enum | false | 用户状态(enabled, disabled) |
createTime | string | false | 创建时间 |
createBy | string | false | 创建人 |
updateTime | string | false | 更新时间 |
updateBy | string | false | 修改人 |
orgName | string | false | 所属部门 |
postName | string | false | 岗位名称 |
roleNames | string | false | 角色名称列表 |
roleIds | array | false | 角色列表 |
Request-body:
{
"id": 0,
"sex": "",
"orgId": 0,
"postId": 0,
"name": "",
"email": "",
"phone": "",
"avatar": "",
"remark": "",
"account": "",
"status": "enabled",
"createTime": "yyyy-MM-dd HH:mm:ss",
"createBy": "",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"updateBy": "",
"orgName": "",
"postName": "",
"roleNames": "",
"roleIds": [
0
]
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/admin/edit' --data '{
"id": 0,
"sex": "",
"orgId": 0,
"postId": 0,
"name": "",
"email": "",
"phone": "",
"avatar": "",
"remark": "",
"account": "",
"status": "enabled",
"createTime": "yyyy-MM-dd HH:mm:ss",
"createBy": "",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"updateBy": "",
"orgName": "",
"postName": "",
"roleNames": "",
"roleIds": [
0
]
}'1.3.5. 获取用户详情
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取用户详情
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─sex | string | 性别 | - |
└─orgId | int64 | 所属部门 | - |
└─postId | int64 | 所属岗位 | - |
└─name | string | 用户昵称 | - |
string | 邮箱 | - | |
└─phone | string | 手机号 | - |
└─avatar | string | 用户头像 | - |
└─remark | string | 备注 | - |
└─account | string | 用户账号 | - |
└─status | enum | 用户状态(enabled, disabled) | - |
└─createTime | string | 创建时间 | - |
└─createBy | string | 创建人 | - |
└─updateTime | string | 更新时间 | - |
└─updateBy | string | 修改人 | - |
└─orgName | string | 所属部门 | - |
└─postName | string | 岗位名称 | - |
└─roleNames | string | 角色名称列表 | - |
└─roleIds | array | 角色列表 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"sex": "",
"orgId": 0,
"postId": 0,
"name": "",
"email": "",
"phone": "",
"avatar": "",
"remark": "",
"account": "",
"status": "enabled",
"createTime": "yyyy-MM-dd HH:mm:ss",
"createBy": "",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"updateBy": "",
"orgName": "",
"postName": "",
"roleNames": "",
"roleIds": [
0
]
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/admin/detail'1.3.6. 删除用户
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除用户
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
list | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/admin/del' --data '[
0
]'1.3.7. 导入用户
Type: POST
Author: iteaj
Content-Type: multipart/form-data
Description: 导入用户
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
file | file | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | string | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": ""
}Curl-example:
curl -X POST -H 'Content-Type: multipart/form-data' -F 'file=' -i 'http://127.0.0.1:8085/api/core/admin/import'1.3.8. 导出用户
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 导出用户
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
sex | string | false | 性别 | ||
orgId | int64 | false | 所属部门 | ||
postId | int64 | false | 所属岗位 | ||
name | string | false | 用户昵称 | ||
string | false | 邮箱 | |||
phone | string | false | 手机号 | ||
avatar | string | false | 用户头像 | ||
remark | string | false | 备注 | ||
account | string | false | 用户账号 | ||
status | enum | false | 用户状态(enabled, disabled) | ||
createTime | string | false | 创建时间 | ||
createBy | string | false | 创建人 | ||
updateTime | string | false | 更新时间 | ||
updateBy | string | false | 修改人 |
Response-example:
Return void.Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/admin/export?size=0¤t=0&id=0&orgId=0&postId=0&status=enabled&createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&records[0].sex=&records[0].postId=0&records[0].remark=&orders[0].postId=0&orders[0].createTime=yyyy-MM-dd HH:mm:ss&email=&records[0].status=enabled&orders[0].id=0&records[0].updateBy=&updateBy=&hitCount=true&records[0].email=&total=0&orders[0].updateTime=yyyy-MM-dd HH:mm:ss&account=&orders[0].avatar=&countId=&maxLimit=0&avatar=&records[0].createBy=&records[0].orgId=0&orders[0].sex=&orders[0].orgId=0&orders[0].phone=&orders[0].createBy=&orders[0].name=&orders[0].updateBy=&pages=0&records[0].name=&records[0].account=&records[0].phone=&createBy=&orders[0].email=&records[0].avatar=&name=&records[0].id=0&phone=&remark=&orders[0].remark=&isSearchCount=true&orders[0].status=enabled&records[0].updateTime=yyyy-MM-dd HH:mm:ss&orders[0].account=&sex=&records[0].createTime=yyyy-MM-dd HH:mm:ss&optimizeCountSql=true'1.3.9. 修改用户信息
Type: POST
Author: iteaj
Content-Type: application/json
Description: 修改用户信息
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
sex | string | false | 性别 |
orgId | int64 | false | 所属部门 |
postId | int64 | false | 所属岗位 |
name | string | false | 用户昵称 |
string | false | 邮箱 | |
phone | string | false | 手机号 |
avatar | string | false | 用户头像 |
remark | string | false | 备注 |
account | string | false | 用户账号 |
status | enum | false | 用户状态(enabled, disabled) |
createTime | string | false | 创建时间 |
createBy | string | false | 创建人 |
updateTime | string | false | 更新时间 |
updateBy | string | false | 修改人 |
Request-body:
{
"id": 0,
"sex": "",
"orgId": 0,
"postId": 0,
"name": "",
"email": "",
"phone": "",
"avatar": "",
"remark": "",
"account": "",
"status": "enabled",
"createTime": "yyyy-MM-dd HH:mm:ss",
"createBy": "",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"updateBy": ""
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/admin/modUserInfo' --data '{
"id": 0,
"sex": "",
"orgId": 0,
"postId": 0,
"name": "",
"email": "",
"phone": "",
"avatar": "",
"remark": "",
"account": "",
"status": "enabled",
"createTime": "yyyy-MM-dd HH:mm:ss",
"createBy": "",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"updateBy": ""
}'1.3.10. 设置用户密码
Type: POST
Author: iteaj
Content-Type: application/json
Description: 设置用户密码
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | 用户唯一标识 |
oldPwd | string | false | 旧密码 |
password | string | false | 新密码 |
Request-body:
{
"id": 0,
"oldPwd": "",
"password": ""
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/admin/pwd' --data '{
"id": 0,
"oldPwd": "",
"password": ""
}'1.3.11. 设置用户密码
Type: POST
Author: iteaj
Content-Type: application/json
Description: 设置用户密码
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | 用户唯一标识 |
oldPwd | string | false | 旧密码 |
password | string | false | 新密码 |
Request-body:
{
"id": 0,
"oldPwd": "",
"password": ""
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/admin/updateCurrentPwd' --data '{
"id": 0,
"oldPwd": "",
"password": ""
}'1.4. 系统配置管理
1.4.1. 查询配置列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 查询配置列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
name | string | false | No comments found. | ||
label | string | false | No comments found. | ||
value | string | false | No comments found. | ||
remark | string | false | No comments found. | ||
type | enum | false | No comments found. | ||
createTime | string | false | 创建时间 | ||
updateTime | string | false | 更新时间 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─name | string | No comments found. | - |
└─label | string | No comments found. | - |
└─value | string | No comments found. | - |
└─remark | string | No comments found. | - |
└─type | enum | No comments found. | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"name": "",
"label": "",
"value": "",
"remark": "",
"type": "def",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/config/view?size=0¤t=0&id=0&type=def&createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&value=&total=0&pages=0&hitCount=true&name=&optimizeCountSql=true&isSearchCount=true&maxLimit=0&label=&remark=&countId='1.4.2. 查询配置列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 查询配置列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. | ||
name | string | false | No comments found. | ||
label | string | false | No comments found. | ||
value | string | false | No comments found. | ||
remark | string | false | No comments found. | ||
type | enum | false | No comments found. | ||
createTime | string | false | 创建时间 | ||
updateTime | string | false | 更新时间 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─name | string | No comments found. | - |
└─label | string | No comments found. | - |
└─value | string | No comments found. | - |
└─remark | string | No comments found. | - |
└─type | enum | No comments found. | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"name": "",
"label": "",
"value": "",
"remark": "",
"type": "def",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/config/list?id=0&type=def&createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&value=&name=&remark=&label='1.4.3. 新增配置
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增配置
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
name | string | false | No comments found. |
label | string | false | No comments found. |
value | string | false | No comments found. |
remark | string | false | No comments found. |
type | enum | false | No comments found. |
createTime | string | false | 创建时间 |
updateTime | string | false | 更新时间 |
Request-body:
{
"id": 0,
"name": "",
"label": "",
"value": "",
"remark": "",
"type": "def",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/config/add' --data '{
"id": 0,
"name": "",
"label": "",
"value": "",
"remark": "",
"type": "def",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}'1.4.4. 获取编辑详情
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑详情
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─name | string | No comments found. | - |
└─label | string | No comments found. | - |
└─value | string | No comments found. | - |
└─remark | string | No comments found. | - |
└─type | enum | No comments found. | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"name": "",
"label": "",
"value": "",
"remark": "",
"type": "def",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/config/edit?id=0&=f5oogn'1.4.5. 修改配置
Type: POST
Author: iteaj
Content-Type: application/json
Description: 修改配置
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
name | string | false | No comments found. |
label | string | false | No comments found. |
value | string | false | No comments found. |
remark | string | false | No comments found. |
type | enum | false | No comments found. |
createTime | string | false | 创建时间 |
updateTime | string | false | 更新时间 |
Request-body:
{
"id": 0,
"name": "",
"label": "",
"value": "",
"remark": "",
"type": "def",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/config/edit' --data '{
"id": 0,
"name": "",
"label": "",
"value": "",
"remark": "",
"type": "def",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}'1.4.6. 删除记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
list | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/config/del' --data '[
0
]'1.5. 系统功能统计
1.5.1. 当天在线人数和在前在线人数
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 当天在线人数和在前在线人数
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─currentOnline | int64 | 当前在线人数 | - |
└─todayAccess | int64 | 当天访问人数 | - |
└─loginAccount | int64 | 登录账号数 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"currentOnline": 0,
"todayAccess": 0,
"loginAccount": 0
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/statistics/online'1.5.2. 近一个月在线用户统计
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 近一个月在线用户统计
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/statistics/inRecentMonth'1.6. 字典数据管理
1.6.1. 获取字典数据列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取字典数据列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. | ||
sort | int32 | false | 排序 | ||
label | string | false | 字典标签 | ||
value | string | false | 字典标签值 | ||
type | string | false | 类型 | ||
status | enum | false | 字典状态 | ||
remark | string | false | 备注 | ||
izDefault | boolean | false | No comments found. | ||
createTime | string | false | 创建时间 | ||
updateTime | string | false | 更新时间 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─label | string | 字典标签 | - |
└─value | string | 字典标签值 | - |
└─type | string | 类型 | - |
└─status | enum | 字典状态 | - |
└─remark | string | 备注 | - |
└─izDefault | boolean | No comments found. | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"sort": 0,
"label": "",
"value": "",
"type": "",
"status": "enabled",
"remark": "",
"izDefault": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/dictData/view?id=0&sort=0&status=enabled&izDefault=true&createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&type=&value=&label=&remark='1.6.2. 获取指定类型的字典数据
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取指定类型的字典数据
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
type | string | false | 字典类型 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─label | string | 字典标签 | - |
└─value | string | 字典标签值 | - |
└─type | string | 类型 | - |
└─status | enum | 字典状态 | - |
└─remark | string | 备注 | - |
└─izDefault | boolean | No comments found. | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"sort": 0,
"label": "",
"value": "",
"type": "",
"status": "enabled",
"remark": "",
"izDefault": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/dictData/listByType?=0jtb1e'1.6.3. 新增一条字典数据记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增一条字典数据记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
sort | int32 | false | 排序 |
label | string | false | 字典标签 |
value | string | false | 字典标签值 |
type | string | false | 类型 |
status | enum | false | 字典状态 |
remark | string | false | 备注 |
izDefault | boolean | false | No comments found. |
createTime | string | false | 创建时间 |
updateTime | string | false | 更新时间 |
Request-body:
{
"id": 0,
"sort": 0,
"label": "",
"value": "",
"type": "",
"status": "enabled",
"remark": "",
"izDefault": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/dictData/add' --data '{
"id": 0,
"sort": 0,
"label": "",
"value": "",
"type": "",
"status": "enabled",
"remark": "",
"izDefault": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}'1.6.4. 删除字典数据
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除字典数据
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
list | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/dictData/del' --data '[
0
]'1.6.5. 获取字典数据详情
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取字典数据详情
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─label | string | 字典标签 | - |
└─value | string | 字典标签值 | - |
└─type | string | 类型 | - |
└─status | enum | 字典状态 | - |
└─remark | string | 备注 | - |
└─izDefault | boolean | No comments found. | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"sort": 0,
"label": "",
"value": "",
"type": "",
"status": "enabled",
"remark": "",
"izDefault": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/dictData/edit?id=0&=vg93jj'1.6.6. 修改字典数据记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 修改字典数据记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
sort | int32 | false | 排序 |
label | string | false | 字典标签 |
value | string | false | 字典标签值 |
type | string | false | 类型 |
status | enum | false | 字典状态 |
remark | string | false | 备注 |
izDefault | boolean | false | No comments found. |
createTime | string | false | 创建时间 |
updateTime | string | false | 更新时间 |
Request-body:
{
"id": 0,
"sort": 0,
"label": "",
"value": "",
"type": "",
"status": "enabled",
"remark": "",
"izDefault": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/dictData/edit' --data '{
"id": 0,
"sort": 0,
"label": "",
"value": "",
"type": "",
"status": "enabled",
"remark": "",
"izDefault": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}'1.7. 字典类型管理
1.7.1. 查询字典列表(分页)
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 查询字典列表(分页)
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. | ||
type | string | false | 字典类型 | ||
name | string | false | 类型名称 | ||
status | enum | false | 类型状态 | ||
remark | string | false | 备注 | ||
createTime | string | false | 创建时间 | ||
updateTime | string | false | 更新时间 | ||
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─type | string | 字典类型 | - |
└─name | string | 类型名称 | - |
└─status | enum | 类型状态 | - |
└─remark | string | 备注 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
└─total | int64 | No comments found. | - |
└─size | int64 | No comments found. | - |
└─current | int64 | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"records": [
{
"id": 0,
"type": "",
"name": "",
"status": "enabled",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
],
"total": 0,
"size": 0,
"current": 0
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/dictType/view?id=0&status=enabled&createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&size=0¤t=0&total=0&optimizeCountSql=true&countId=&remark=&hitCount=true&type=&name=&isSearchCount=true&pages=0&maxLimit=0'1.7.2. 获取所有字典类型记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取所有字典类型记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. | ||
type | string | false | 字典类型 | ||
name | string | false | 类型名称 | ||
status | enum | false | 类型状态 | ||
remark | string | false | 备注 | ||
createTime | string | false | 创建时间 | ||
updateTime | string | false | 更新时间 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─type | string | 字典类型 | - |
└─name | string | 类型名称 | - |
└─status | enum | 类型状态 | - |
└─remark | string | 备注 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"type": "",
"name": "",
"status": "enabled",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/dictType/list?id=0&status=enabled&createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&remark=&name=&type='1.7.3. 新增字典记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增字典记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
type | string | false | 字典类型 |
name | string | false | 类型名称 |
status | enum | false | 类型状态 |
remark | string | false | 备注 |
createTime | string | false | 创建时间 |
updateTime | string | false | 更新时间 |
Request-body:
{
"id": 0,
"type": "",
"name": "",
"status": "enabled",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/dictType/add' --data '{
"id": 0,
"type": "",
"name": "",
"status": "enabled",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}'1.7.4. 获取字典记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取字典记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─type | string | 字典类型 | - |
└─name | string | 类型名称 | - |
└─status | enum | 类型状态 | - |
└─remark | string | 备注 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"type": "",
"name": "",
"status": "enabled",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/dictType/edit?id=0&=bh5o8e'1.7.5. 修改字典记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 修改字典记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
type | string | false | 字典类型 |
name | string | false | 类型名称 |
status | enum | false | 类型状态 |
remark | string | false | 备注 |
createTime | string | false | 创建时间 |
updateTime | string | false | 更新时间 |
Request-body:
{
"id": 0,
"type": "",
"name": "",
"status": "enabled",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/dictType/edit' --data '{
"id": 0,
"type": "",
"name": "",
"status": "enabled",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}'1.7.6. 删除字典
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除字典
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
list | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/dictType/del' --data '[
0
]'1.8. 用户管理中心接口
1.8.1. 系统登录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 系统登录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
code | string | false | 校验码token |
account | string | false | 账号 |
username | string | false | 用户名 |
password | string | false | 密码 |
captcha | string | false | 验证码 |
rememberMe | boolean | false | No comments found. |
Request-body:
{
"code": "",
"account": "",
"username": "",
"password": "",
"captcha": "",
"rememberMe": true
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/login' --data '{
"code": "",
"account": "",
"username": "",
"password": "",
"captcha": "",
"rememberMe": true
}'1.8.2. 系统注销
Type: POST
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 系统注销
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {}
}Curl-example:
curl -X POST -i 'http://127.0.0.1:8085/api/core/logout'1.9. 系统菜单管理
1.9.1. 获取菜单列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取菜单列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. | ||
children | array | false | 此节点的子节点 | ||
pid | int64 | false | 当前树节点的父节点 | ||
url | string | false | 菜单地址 | ||
name | string | false | 菜单名称 | ||
msn | string | false | 所属模块 | ||
sort | int32 | false | 排序 | ||
icon | string | false | 图标 | ||
status | enum | false | 是否显示 | ||
perms | string | false | 权限列表 | ||
remark | string | false | 备注 | ||
type | enum | false | 菜单类型 | ||
target | string | false | 打开方式 | ||
createTime | string | false | 创建时间 | ||
updateTime | string | false | 更新时间 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─children | array | 此节点的子节点 | - |
└─pid | int64 | 当前树节点的父节点 | - |
└─url | string | 菜单地址 | - |
└─name | string | 菜单名称 | - |
└─msn | string | 所属模块 | - |
└─sort | int32 | 排序 | - |
└─icon | string | 图标 | - |
└─status | enum | 是否显示 | - |
└─perms | string | 权限列表 | - |
└─remark | string | 备注 | - |
└─type | enum | 菜单类型 | - |
└─target | string | 打开方式 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"url": "",
"name": "",
"msn": "",
"sort": 0,
"icon": "",
"status": "enabled",
"perms": "",
"remark": "",
"type": "A",
"target": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/menu/view?id=0&pid=0&sort=0&status=enabled&type=A&createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&name=&msn=&url=&icon=&target=&perms=&remark='1.9.2. 菜单栏菜单列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 菜单栏菜单列表
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─children | array | 此节点的子节点 | - |
└─pid | int64 | 当前树节点的父节点 | - |
└─url | string | 菜单地址 | - |
└─name | string | 菜单名称 | - |
└─msn | string | 所属模块 | - |
└─sort | int32 | 排序 | - |
└─icon | string | 图标 | - |
└─status | enum | 是否显示 | - |
└─perms | string | 权限列表 | - |
└─remark | string | 备注 | - |
└─type | enum | 菜单类型 | - |
└─target | string | 打开方式 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"url": "",
"name": "",
"msn": "",
"sort": 0,
"icon": "",
"status": "enabled",
"perms": "",
"remark": "",
"type": "A",
"target": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/menu/bars'1.9.3. 获取权限列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取权限列表
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
"",
""
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/menu/permissions'1.9.4. 获取除权限外的菜单
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取除权限外的菜单
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─children | array | 此节点的子节点 | - |
└─pid | int64 | 当前树节点的父节点 | - |
└─url | string | 菜单地址 | - |
└─name | string | 菜单名称 | - |
└─msn | string | 所属模块 | - |
└─sort | int32 | 排序 | - |
└─icon | string | 图标 | - |
└─status | enum | 是否显示 | - |
└─perms | string | 权限列表 | - |
└─remark | string | 备注 | - |
└─type | enum | 菜单类型 | - |
└─target | string | 打开方式 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"url": "",
"name": "",
"msn": "",
"sort": 0,
"icon": "",
"status": "enabled",
"perms": "",
"remark": "",
"type": "A",
"target": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/menu/parent'1.9.5. 新增菜单
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增菜单
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
children | array | false | 此节点的子节点 |
pid | int64 | false | 当前树节点的父节点 |
url | string | false | 菜单地址 |
name | string | false | 菜单名称 |
msn | string | false | 所属模块 |
sort | int32 | false | 排序 |
icon | string | false | 图标 |
status | enum | false | 是否显示 |
perms | string | false | 权限列表 |
remark | string | false | 备注 |
type | enum | false | 菜单类型 |
target | string | false | 打开方式 |
createTime | string | false | 创建时间 |
updateTime | string | false | 更新时间 |
Request-body:
{
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"url": "",
"name": "",
"msn": "",
"sort": 0,
"icon": "",
"status": "enabled",
"perms": "",
"remark": "",
"type": "A",
"target": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/menu/add' --data '{
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"url": "",
"name": "",
"msn": "",
"sort": 0,
"icon": "",
"status": "enabled",
"perms": "",
"remark": "",
"type": "A",
"target": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}'1.9.6. 删除菜单
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除菜单
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/menu/del' --data '[
0
]'1.9.7. 获取编辑详情
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑详情
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─children | array | 此节点的子节点 | - |
└─pid | int64 | 当前树节点的父节点 | - |
└─url | string | 菜单地址 | - |
└─name | string | 菜单名称 | - |
└─msn | string | 所属模块 | - |
└─sort | int32 | 排序 | - |
└─icon | string | 图标 | - |
└─status | enum | 是否显示 | - |
└─perms | string | 权限列表 | - |
└─remark | string | 备注 | - |
└─type | enum | 菜单类型 | - |
└─target | string | 打开方式 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"url": "",
"name": "",
"msn": "",
"sort": 0,
"icon": "",
"status": "enabled",
"perms": "",
"remark": "",
"type": "A",
"target": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/menu/edit?id=0&=4d5x1l'1.9.8. 编辑菜单
Type: POST
Author: iteaj
Content-Type: application/json
Description: 编辑菜单
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
children | array | false | 此节点的子节点 |
pid | int64 | false | 当前树节点的父节点 |
url | string | false | 菜单地址 |
name | string | false | 菜单名称 |
msn | string | false | 所属模块 |
sort | int32 | false | 排序 |
icon | string | false | 图标 |
status | enum | false | 是否显示 |
perms | string | false | 权限列表 |
remark | string | false | 备注 |
type | enum | false | 菜单类型 |
target | string | false | 打开方式 |
createTime | string | false | 创建时间 |
updateTime | string | false | 更新时间 |
Request-body:
{
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"url": "",
"name": "",
"msn": "",
"sort": 0,
"icon": "",
"status": "enabled",
"perms": "",
"remark": "",
"type": "A",
"target": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/menu/edit' --data '{
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"url": "",
"name": "",
"msn": "",
"sort": 0,
"icon": "",
"status": "enabled",
"perms": "",
"remark": "",
"type": "A",
"target": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}'1.9.9. 获取模块列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取模块列表
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─order | int32 | 排序值 | - |
└─msn | string | 模块标识, 用于菜单的msn | - |
└─name | string | 模块名称 | - |
└─plugin | boolean | 是模块还是插件 | - |
└─tablePrefix | string | 表前缀 | - |
└─packageName | string | 模块包名 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"order": 0,
"msn": "",
"name": "",
"plugin": true,
"tablePrefix": "",
"packageName": ""
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/menu/msn'1.10. 系统通知管理
1.10.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
title | string | false | 消息标题 | ||
createUser | int64 | false | 机构id | ||
content | string | false | 消息内容 | ||
type | string | false | 消息类型 | ||
createTime | string | false | 创建时间 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─title | string | 消息标题 | - |
└─createUser | int64 | 机构id | - |
└─content | string | 消息内容 | - |
└─type | string | 消息类型 | - |
└─createTime | string | 创建时间 | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"title": "",
"createUser": 0,
"content": "",
"type": "",
"createTime": "yyyy-MM-dd HH:mm:ss"
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/notify/view?size=0¤t=0&id=0&createUser=0&createTime=yyyy-MM-dd HH:mm:ss&orders[0].content=&records[0].type=&records[0].createTime=yyyy-MM-dd HH:mm:ss&records[0].content=&orders[0].type=&orders[0].createTime=yyyy-MM-dd HH:mm:ss&countId=&orders[0].title=&records[0].id=0&orders[0].createUser=0&title=&pages=0&isSearchCount=true&type=&orders[0].id=0&total=0&optimizeCountSql=true&hitCount=true&maxLimit=0&records[0].title=&records[0].createUser=0&content='1.10.2. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | 记录id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─title | string | 消息标题 | - |
└─createUser | int64 | 机构id | - |
└─content | string | 消息内容 | - |
└─type | string | 消息类型 | - |
└─createTime | string | 创建时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"title": "",
"createUser": 0,
"content": "",
"type": "",
"createTime": "yyyy-MM-dd HH:mm:ss"
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/notify/edit?id=0&=itxi8n'1.10.3. 新增或者更新记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
title | string | false | 消息标题 |
createUser | int64 | false | 机构id |
content | string | false | 消息内容 |
type | string | false | 消息类型 |
createTime | string | false | 创建时间 |
Request-body:
{
"id": 0,
"title": "",
"createUser": 0,
"content": "",
"type": "",
"createTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/notify/saveOrUpdate' --data '{
"id": 0,
"title": "",
"createUser": 0,
"content": "",
"type": "",
"createTime": "yyyy-MM-dd HH:mm:ss"
}'1.10.4. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/notify/del' --data '[
0
]'1.11. 消息通知用户管理
1.11.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
notifyId | int64 | false | 所属通知 | ||
status | boolean | false | 已读状态(false未读 true已读) | ||
readTime | string | false | 已读时间 | ||
createTime | string | false | 创建时间 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─notifyId | int64 | 所属通知 | - |
└─status | boolean | 已读状态(false未读 true已读) | - |
└─readTime | string | 已读时间 | - |
└─createTime | string | 创建时间 | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"notifyId": 0,
"status": true,
"readTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss"
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/notifyUser/view?size=0¤t=0&id=0¬ifyId=0&status=true&readTime=yyyy-MM-dd HH:mm:ss&createTime=yyyy-MM-dd HH:mm:ss&orders[0].id=0&isSearchCount=true&hitCount=true&maxLimit=0&countId=&orders[0].notifyId=0&records[0].readTime=yyyy-MM-dd HH:mm:ss&records[0].id=0&pages=0&orders[0].status=true&total=0&records[0].notifyId=0&optimizeCountSql=true&orders[0].createTime=yyyy-MM-dd HH:mm:ss&records[0].status=true&records[0].createTime=yyyy-MM-dd HH:mm:ss&orders[0].readTime=yyyy-MM-dd HH:mm:ss'1.11.2. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | 记录id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─notifyId | int64 | 所属通知 | - |
└─status | boolean | 已读状态(false未读 true已读) | - |
└─readTime | string | 已读时间 | - |
└─createTime | string | 创建时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"notifyId": 0,
"status": true,
"readTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss"
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/notifyUser/edit?id=0&=lw4bdr'1.11.3. 新增或者更新记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
notifyId | int64 | false | 所属通知 |
status | boolean | false | 已读状态(false未读 true已读) |
readTime | string | false | 已读时间 |
createTime | string | false | 创建时间 |
Request-body:
{
"id": 0,
"notifyId": 0,
"status": true,
"readTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/notifyUser/saveOrUpdate' --data '{
"id": 0,
"notifyId": 0,
"status": true,
"readTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss"
}'1.11.4. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/notifyUser/del' --data '[
0
]'1.12. 在线用户管理
1.12.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
action | string | false | No comments found. | ||
timeout | int64 | false | No comments found. | ||
startTimestamp | string | false | No comments found. | ||
lastAccessTime | string | false | No comments found. | ||
account | string | false | No comments found. | ||
sessionId | string | false | 会话编号 | ||
browse | string | false | 登录时使用的浏览器 | ||
expireTime | int64 | false | 超时时长, 从访问到离开的时间, 单位分钟 | ||
location | string | false | 访问的本地位置 | ||
accessIp | string | false | 访问ip | ||
loginTime | string | false | 登录时间 | ||
os | string | false | 使用的操作系统 | ||
type | enum | false | 应用类型 | ||
status | enum | false | 用户状态(Online. 在线, Offline. 离线) | ||
userNick | string | false | 用户昵称 | ||
createTime | string | false | 创建时间 | ||
updateTime | string | false | 更新时间 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─action | string | No comments found. | - |
└─timeout | int64 | No comments found. | - |
└─startTimestamp | string | No comments found. | - |
└─lastAccessTime | string | No comments found. | - |
└─account | string | No comments found. | - |
└─sessionId | string | 会话编号 | - |
└─browse | string | 登录时使用的浏览器 | - |
└─expireTime | int64 | 超时时长, 从访问到离开的时间, 单位分钟 | - |
└─location | string | 访问的本地位置 | - |
└─accessIp | string | 访问ip | - |
└─loginTime | string | 登录时间 | - |
└─os | string | 使用的操作系统 | - |
└─type | enum | 应用类型 | - |
└─status | enum | 用户状态(Online. 在线, Offline. 离线) | - |
└─userNick | string | 用户昵称 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"action": "",
"timeout": 0,
"startTimestamp": "yyyy-MM-dd HH:mm:ss",
"lastAccessTime": "yyyy-MM-dd HH:mm:ss",
"account": "",
"sessionId": "",
"browse": "",
"expireTime": 0,
"location": "",
"accessIp": "",
"loginTime": "yyyy-MM-dd HH:mm:ss",
"os": "",
"type": "COMPUTER",
"status": "Online",
"userNick": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/online/view?size=0¤t=0&id=0&timeout=0&startTimestamp=yyyy-MM-dd HH:mm:ss&lastAccessTime=yyyy-MM-dd HH:mm:ss&expireTime=0&loginTime=yyyy-MM-dd HH:mm:ss&type=COMPUTER&status=Online&createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&records[0].location=&account=&records[0].browse=&orders[0].timeout=0&records[0].account=&records[0].os=&orders[0].browse=&orders[0].loginTime=yyyy-MM-dd HH:mm:ss&orders[0].status=Online&accessIp=&orders[0].accessIp=&browse=&isSearchCount=true&countId=&action=&orders[0].lastAccessTime=yyyy-MM-dd HH:mm:ss&orders[0].updateTime=yyyy-MM-dd HH:mm:ss&records[0].updateTime=yyyy-MM-dd HH:mm:ss&maxLimit=0&orders[0].action=&orders[0].os=&os=&records[0].type=COMPUTER&orders[0].id=0&orders[0].expireTime=0&hitCount=true&orders[0].startTimestamp=yyyy-MM-dd HH:mm:ss&userNick=&records[0].startTimestamp=yyyy-MM-dd HH:mm:ss&records[0].action=&records[0].id=0&records[0].timeout=0&records[0].lastAccessTime=yyyy-MM-dd HH:mm:ss&optimizeCountSql=true&records[0].loginTime=yyyy-MM-dd HH:mm:ss&pages=0&records[0].expireTime=0&records[0].sessionId=&records[0].accessIp=&orders[0].account=&records[0].createTime=yyyy-MM-dd HH:mm:ss&orders[0].userNick=&records[0].status=Online&orders[0].createTime=yyyy-MM-dd HH:mm:ss&location=&total=0&sessionId=&orders[0].sessionId=&orders[0].location=&records[0].userNick=&orders[0].type=COMPUTER'1.12.2. 删除在线记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除在线记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/online/del' --data '[
0
]'1.12.3. 剔除用户下线
Type: POST
Author: iteaj
Content-Type: application/json
Description: 剔除用户下线
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
action | string | false | No comments found. |
timeout | int64 | false | No comments found. |
startTimestamp | string | false | No comments found. |
lastAccessTime | string | false | No comments found. |
account | string | false | No comments found. |
sessionId | string | false | 会话编号 |
browse | string | false | 登录时使用的浏览器 |
expireTime | int64 | false | 超时时长, 从访问到离开的时间, 单位分钟 |
location | string | false | 访问的本地位置 |
accessIp | string | false | 访问ip |
loginTime | string | false | 登录时间 |
os | string | false | 使用的操作系统 |
type | enum | false | 应用类型 |
status | enum | false | 用户状态(Online. 在线, Offline. 离线) |
userNick | string | false | 用户昵称 |
createTime | string | false | 创建时间 |
updateTime | string | false | 更新时间 |
Request-body:
{
"id": 0,
"action": "",
"timeout": 0,
"startTimestamp": "yyyy-MM-dd HH:mm:ss",
"lastAccessTime": "yyyy-MM-dd HH:mm:ss",
"account": "",
"sessionId": "",
"browse": "",
"expireTime": 0,
"location": "",
"accessIp": "",
"loginTime": "yyyy-MM-dd HH:mm:ss",
"os": "",
"type": "COMPUTER",
"status": "Online",
"userNick": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/online/offline' --data '{
"id": 0,
"action": "",
"timeout": 0,
"startTimestamp": "yyyy-MM-dd HH:mm:ss",
"lastAccessTime": "yyyy-MM-dd HH:mm:ss",
"account": "",
"sessionId": "",
"browse": "",
"expireTime": 0,
"location": "",
"accessIp": "",
"loginTime": "yyyy-MM-dd HH:mm:ss",
"os": "",
"type": "COMPUTER",
"status": "Online",
"userNick": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}'1.12.4. 统计当天用户信息
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 统计当天用户信息
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─currentOnline | int64 | 当前在线人数 | - |
└─todayAccess | int64 | 当天访问人数 | - |
└─loginAccount | int64 | 登录账号数 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"currentOnline": 0,
"todayAccess": 0,
"loginAccount": 0
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/online/countToday'1.12.5. 统计最近一个月的访问用户
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 统计最近一个月的访问用户
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/online/countLastMonth'1.13. 日志管理功能
1.13.1. 获取日志记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取日志记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
ip | string | false | 请求ip | ||
url | string | false | 请求地址 | ||
type | enum | false | 功能类型 | ||
userId | int64 | false | 访问用户 | ||
params | string | false | 请求参数 | ||
method | string | false | 请求方法 | ||
millis | int64 | false | 使用时间 | ||
userName | string | false | 用户名 | ||
status | boolean | false | 状态 | ||
errMsg | string | false | 错误消息 | ||
title | string | false | 功能 | ||
createTime | string | false | 创建时间 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/log/view?size=0¤t=0&id=0&type=Func&userId=0&millis=0&status=true&createTime=yyyy-MM-dd HH:mm:ss¶ms=&maxLimit=0&method=&userName=&countId=&ip=&isSearchCount=true&optimizeCountSql=true&pages=0&title=&hitCount=true&url=&errMsg=&total=0'1.13.2. 删除日志记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除日志记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
list | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/log/del' --data '[
0
]'1.14. 组织部门管理
1.14.1. 获取部门列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取部门列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. | ||
children | array | false | 此节点的子节点 | ||
pid | int64 | false | 当前树节点的父节点 | ||
name | string | false | 部门名称 | ||
sort | int32 | false | 排序 | ||
phone | string | false | 部门负责人电话 | ||
leader | string | false | 部门负责人 | ||
path | string | false | 部门路径 | ||
level | int32 | false | 部门等级 | ||
createTime | string | false | 创建时间 | ||
updateTime | string | false | 更新时间 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─children | array | 此节点的子节点 | - |
└─pid | int64 | 当前树节点的父节点 | - |
└─name | string | 部门名称 | - |
└─sort | int32 | 排序 | - |
└─phone | string | 部门负责人电话 | - |
└─leader | string | 部门负责人 | - |
└─path | string | 部门路径 | - |
└─level | int32 | 部门等级 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"name": "",
"sort": 0,
"phone": "",
"leader": "",
"path": "",
"level": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/org/view?id=0&pid=0&sort=0&level=0&createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&phone=&leader=&name=&path='1.14.2.
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description:
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─children | array | 此节点的子节点 | - |
└─pid | int64 | 当前树节点的父节点 | - |
└─name | string | 部门名称 | - |
└─sort | int32 | 排序 | - |
└─phone | string | 部门负责人电话 | - |
└─leader | string | 部门负责人 | - |
└─path | string | 部门路径 | - |
└─level | int32 | 部门等级 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"name": "",
"sort": 0,
"phone": "",
"leader": "",
"path": "",
"level": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/org/parent'1.14.3. 新增部门
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增部门
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
children | array | false | 此节点的子节点 |
pid | int64 | false | 当前树节点的父节点 |
name | string | false | 部门名称 |
sort | int32 | false | 排序 |
phone | string | false | 部门负责人电话 |
leader | string | false | 部门负责人 |
path | string | false | 部门路径 |
level | int32 | false | 部门等级 |
createTime | string | false | 创建时间 |
updateTime | string | false | 更新时间 |
Request-body:
{
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"name": "",
"sort": 0,
"phone": "",
"leader": "",
"path": "",
"level": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/org/add' --data '{
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"name": "",
"sort": 0,
"phone": "",
"leader": "",
"path": "",
"level": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}'1.14.4. 获取编辑详情
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑详情
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int32 | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─children | array | 此节点的子节点 | - |
└─pid | int64 | 当前树节点的父节点 | - |
└─name | string | 部门名称 | - |
└─sort | int32 | 排序 | - |
└─phone | string | 部门负责人电话 | - |
└─leader | string | 部门负责人 | - |
└─path | string | 部门路径 | - |
└─level | int32 | 部门等级 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"name": "",
"sort": 0,
"phone": "",
"leader": "",
"path": "",
"level": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/org/edit?id=0&=wgxbn7'1.14.5. 修改部门
Type: POST
Author: iteaj
Content-Type: application/json
Description: 修改部门
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
children | array | false | 此节点的子节点 |
pid | int64 | false | 当前树节点的父节点 |
name | string | false | 部门名称 |
sort | int32 | false | 排序 |
phone | string | false | 部门负责人电话 |
leader | string | false | 部门负责人 |
path | string | false | 部门路径 |
level | int32 | false | 部门等级 |
createTime | string | false | 创建时间 |
updateTime | string | false | 更新时间 |
Request-body:
{
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"name": "",
"sort": 0,
"phone": "",
"leader": "",
"path": "",
"level": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/org/edit' --data '{
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"name": "",
"sort": 0,
"phone": "",
"leader": "",
"path": "",
"level": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}'1.14.6. 删除部门
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除部门
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
list | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/org/del' --data '[
0
]'1.15. 岗位管理管理
1.15.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
sort | int32 | false | 排序 | ||
name | string | false | 岗位名称 | ||
orgId | int64 | false | 所属机构 | ||
remark | string | false | 岗位介绍 | ||
createTime | string | false | 创建时间 | ||
orgName | string | false | 机构名称 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─name | string | 岗位名称 | - |
└─orgId | int64 | 所属机构 | - |
└─remark | string | 岗位介绍 | - |
└─createTime | string | 创建时间 | - |
└─orgName | string | 机构名称 | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"sort": 0,
"name": "",
"orgId": 0,
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"orgName": ""
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/post/view?size=0¤t=0&id=0&sort=0&orgId=0&createTime=yyyy-MM-dd HH:mm:ss&maxLimit=0&records[0].id=0&records[0].sort=0&isSearchCount=true&orders[0].orgId=0&optimizeCountSql=true&orders[0].createTime=yyyy-MM-dd HH:mm:ss&orders[0].orgName=&orders[0].sort=0&name=&orders[0].remark=&records[0].orgName=&total=0&orgName=&remark=&records[0].createTime=yyyy-MM-dd HH:mm:ss&hitCount=true&records[0].name=&orders[0].name=&orders[0].id=0&records[0].remark=&countId=&records[0].orgId=0&pages=0'1.15.2. 获取岗位列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取岗位列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. | ||
sort | int32 | false | 排序 | ||
name | string | false | 岗位名称 | ||
orgId | int64 | false | 所属机构 | ||
remark | string | false | 岗位介绍 | ||
createTime | string | false | 创建时间 | ||
orgName | string | false | 机构名称 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
data | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─name | string | 岗位名称 | - |
└─orgId | int64 | 所属机构 | - |
└─remark | string | 岗位介绍 | - |
└─createTime | string | 创建时间 | - |
└─orgName | string | 机构名称 | - |
code | int64 | No comments found. | - |
message | string | No comments found. | - |
Response-example:
{
"data": [
{
"id": 0,
"sort": 0,
"name": "",
"orgId": 0,
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"orgName": ""
}
],
"code": 0,
"message": ""
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/post/list?id=0&sort=0&orgId=0&createTime=yyyy-MM-dd HH:mm:ss&name=&remark=&orgName='1.15.3. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | 记录id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─name | string | 岗位名称 | - |
└─orgId | int64 | 所属机构 | - |
└─remark | string | 岗位介绍 | - |
└─createTime | string | 创建时间 | - |
└─orgName | string | 机构名称 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"sort": 0,
"name": "",
"orgId": 0,
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"orgName": ""
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/post/edit?id=0&=yvp14r'1.15.4. 新增或者更新记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
sort | int32 | false | 排序 |
name | string | false | 岗位名称 |
orgId | int64 | false | 所属机构 |
remark | string | false | 岗位介绍 |
createTime | string | false | 创建时间 |
orgName | string | false | 机构名称 |
Request-body:
{
"id": 0,
"sort": 0,
"name": "",
"orgId": 0,
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"orgName": ""
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/post/saveOrUpdate' --data '{
"id": 0,
"sort": 0,
"name": "",
"orgId": 0,
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"orgName": ""
}'1.15.5. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/post/del' --data '[
0
]'1.16. 行政区管理
1.16.1. 获取列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. | ||
code | string | false | 行政区码 | ||
name | string | false | 行政区域名称 | ||
firstLetter | string | false | 首字母 | ||
pid | int64 | false | 父级id | ||
level | int32 | false | 等级(第一级为0) |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─code | string | 行政区码 | - |
└─name | string | 行政区域名称 | - |
└─firstLetter | string | 首字母 | - |
└─pid | int64 | 父级id | - |
└─level | int32 | 等级(第一级为0) | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"code": "",
"name": "",
"firstLetter": "",
"pid": 0,
"level": 0
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/region/view?id=0&pid=0&level=0&code=&name=&firstLetter='1.16.2. 获取指定记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取指定记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─code | string | 行政区码 | - |
└─name | string | 行政区域名称 | - |
└─firstLetter | string | 首字母 | - |
└─pid | int64 | 父级id | - |
└─level | int32 | 等级(第一级为0) | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"code": "",
"name": "",
"firstLetter": "",
"pid": 0,
"level": 0
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/region/getById?id=0&=tau32n'1.17. 角色管理
1.17.1. 角色列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 角色列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
name | string | false | 角色名称 | ||
sort | int32 | false | 排序 | ||
status | enum | false | 状态 | ||
remark | string | false | 备注 | ||
createTime | string | false | 创建时间 | ||
updateTime | string | false | 更新时间 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─name | string | 角色名称 | - |
└─sort | int32 | 排序 | - |
└─status | enum | 状态 | - |
└─remark | string | 备注 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"name": "",
"sort": 0,
"status": "enabled",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/role/view?size=0¤t=0&id=0&sort=0&status=enabled&createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&pages=0&optimizeCountSql=true&isSearchCount=true&countId=&maxLimit=0&hitCount=true&name=&total=0&remark='1.17.2. 获取所有角色列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取所有角色列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. | ||
name | string | false | 角色名称 | ||
sort | int32 | false | 排序 | ||
status | enum | false | 状态 | ||
remark | string | false | 备注 | ||
createTime | string | false | 创建时间 | ||
updateTime | string | false | 更新时间 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─name | string | 角色名称 | - |
└─sort | int32 | 排序 | - |
└─status | enum | 状态 | - |
└─remark | string | 备注 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"name": "",
"sort": 0,
"status": "enabled",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/role/list?id=0&sort=0&status=enabled&createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&name=&remark='1.17.3. 所有功能菜单
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 所有功能菜单
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─children | array | 此节点的子节点 | - |
└─pid | int64 | 当前树节点的父节点 | - |
└─url | string | 菜单地址 | - |
└─name | string | 菜单名称 | - |
└─msn | string | 所属模块 | - |
└─sort | int32 | 排序 | - |
└─icon | string | 图标 | - |
└─status | enum | 是否显示 | - |
└─perms | string | 权限列表 | - |
└─remark | string | 备注 | - |
└─type | enum | 菜单类型 | - |
└─target | string | 打开方式 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"url": "",
"name": "",
"msn": "",
"sort": 0,
"icon": "",
"status": "enabled",
"perms": "",
"remark": "",
"type": "A",
"target": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/role/allMenus'1.17.4. 新增角色记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增角色记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
name | string | false | 角色名称 |
sort | int32 | false | 排序 |
status | enum | false | 状态 |
remark | string | false | 备注 |
createTime | string | false | 创建时间 |
updateTime | string | false | 更新时间 |
menuIds | array | false | No comments found. |
Request-body:
{
"id": 0,
"name": "",
"sort": 0,
"status": "enabled",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"menuIds": [
0
]
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/role/add' --data '{
"id": 0,
"name": "",
"sort": 0,
"status": "enabled",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"menuIds": [
0
]
}'1.17.5. 获取详情记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取详情记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─name | string | 角色名称 | - |
└─sort | int32 | 排序 | - |
└─status | enum | 状态 | - |
└─remark | string | 备注 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"name": "",
"sort": 0,
"status": "enabled",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/role/edit?id=0&=2lpv8b'1.17.6. 保存编辑记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 保存编辑记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
name | string | false | 角色名称 |
sort | int32 | false | 排序 |
status | enum | false | 状态 |
remark | string | false | 备注 |
createTime | string | false | 创建时间 |
updateTime | string | false | 更新时间 |
Request-body:
{
"id": 0,
"name": "",
"sort": 0,
"status": "enabled",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/role/edit' --data '{
"id": 0,
"name": "",
"sort": 0,
"status": "enabled",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}'1.17.7. 返回此角色拥有的权限列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 返回此角色拥有的权限列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─menuIds | array | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"menuIds": [
0
]
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/core/role/func?id=0&=96wbqy'1.17.8. 修改角色权限
Type: POST
Author: iteaj
Content-Type: application/json
Description: 修改角色权限
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
name | string | false | 角色名称 |
sort | int32 | false | 排序 |
status | enum | false | 状态 |
remark | string | false | 备注 |
createTime | string | false | 创建时间 |
updateTime | string | false | 更新时间 |
menuIds | array | false | No comments found. |
Request-body:
{
"id": 0,
"name": "",
"sort": 0,
"status": "enabled",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"menuIds": [
0
]
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/role/perm' --data '{
"id": 0,
"name": "",
"sort": 0,
"status": "enabled",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"menuIds": [
0
]
}'1.17.9. 删除记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
list | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/core/role/del' --data '[
0
]'1.18. 通用的文件上传
1.18.1. 文件上传
todo url
Type: POST
Author: iteaj
Content-Type: multipart/form-data
Description: 文件上传
todo url
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
file | file | false | No comments found. | ||
subPath | string | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | string | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": ""
}Curl-example:
curl -X POST -H 'Content-Type: multipart/form-data' -F 'file=' -i 'http://127.0.0.1:8085/api/common/upload' --data '=mfgc19'1.18.2. 文件批量上传
Type: POST
Author: iteaj
Content-Type: multipart/form-data
Description: 文件批量上传
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
file | file | false | No comments found.(array of file) | ||
subPath | string | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
"",
""
]
}Curl-example:
curl -X POST -H 'Content-Type: multipart/form-data' -F 'file=' -i 'http://127.0.0.1:8085/api/common/upload/batch' --data '=k89s91'1.18.3. 上传用户头像
Type: POST
Author: iteaj
Content-Type: multipart/form-data
Description: 上传用户头像
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
file | file | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: multipart/form-data' -F 'file=' -i 'http://127.0.0.1:8085/api/common/upload/avatar'2. 物联网模块
2.1. 采集数据管理
2.1.1. 获取点位数据
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取点位数据
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
fieldId | int64 | false | 采集字段id | ||
taskId | int64 | false | 所属任务(可空) | ||
protocolCode | string | false | 协议码 | ||
productCode | string | false | 产品码 | ||
deviceGroupId | int64 | false | 设备组 | ||
cid | string | false | 任务执行标识 | ||
uid | string | false | 设备uid | ||
signalId | int64 | false | 信号id | ||
field | string | false | 属性 | ||
fieldName | string | false | No comments found. | ||
collectTaskId | int64 | false | 采集任务标识 | ||
address | string | false | 采集地址 | ||
value | string | false | 采集值 | ||
status | boolean | false | 采集状态 | ||
reason | string | false | 采集状态说明 | ||
collectMode | string | false | 采集方式 | ||
collectTime | string | false | 采集时间 | ||
createTime | string | false | 创建时间 | ||
collectStatus | enum | false | 采集状态 | ||
productTypeId | int64 | false | 产品类型id | ||
productId | int64 | false | 产品id | ||
deviceSn | string | false | 设备编号 | ||
deviceName | string | false | 设备名称 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─fieldId | int64 | 采集字段id | - |
└─taskId | int64 | 所属任务(可空) | - |
└─protocolCode | string | 协议码 | - |
└─productCode | string | 产品码 | - |
└─deviceGroupId | int64 | 设备组 | - |
└─cid | string | 任务执行标识 | - |
└─uid | string | 设备uid | - |
└─signalId | int64 | 信号id | - |
└─field | string | 属性 | - |
└─fieldName | string | No comments found. | - |
└─collectTaskId | int64 | 采集任务标识 | - |
└─address | string | 采集地址 | - |
└─value | string | 采集值 | - |
└─status | boolean | 采集状态 | - |
└─reason | string | 采集状态说明 | - |
└─collectMode | string | 采集方式 | - |
└─collectTime | string | 采集时间 | - |
└─createTime | string | 创建时间 | - |
└─collectStatus | enum | 采集状态 | - |
└─productTypeId | int64 | 产品类型id | - |
└─productId | int64 | 产品id | - |
└─deviceSn | string | 设备编号 | - |
└─deviceName | string | 设备名称 | - |
└─total | int64 | No comments found. | - |
└─size | int64 | No comments found. | - |
└─current | int64 | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"records": [
{
"id": 0,
"fieldId": 0,
"taskId": 0,
"protocolCode": "",
"productCode": "",
"deviceGroupId": 0,
"cid": "",
"uid": "",
"signalId": 0,
"field": "",
"fieldName": "",
"collectTaskId": 0,
"address": "",
"value": "",
"status": true,
"reason": "",
"collectMode": "",
"collectTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"collectStatus": "Success",
"productTypeId": 0,
"productId": 0,
"deviceSn": "",
"deviceName": ""
}
],
"total": 0,
"size": 0,
"current": 0
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/collectData/signal?size=0¤t=0&id=0&fieldId=0&taskId=0&deviceGroupId=0&signalId=0&collectTaskId=0&status=true&collectTime=yyyy-MM-dd HH:mm:ss&createTime=yyyy-MM-dd HH:mm:ss&collectStatus=Success&productTypeId=0&productId=0&uid=&address=&optimizeCountSql=true&protocolCode=&deviceSn=&field=&maxLimit=0&countId=&productCode=&deviceName=&reason=&fieldName=&isSearchCount=true&cid=&pages=0&hitCount=true&value=&total=0&collectMode='2.1.2. 获取模型数据
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取模型数据
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
fieldId | int64 | false | 采集字段id | ||
taskId | int64 | false | 所属任务(可空) | ||
protocolCode | string | false | 协议码 | ||
productCode | string | false | 产品码 | ||
deviceGroupId | int64 | false | 设备组 | ||
cid | string | false | 任务执行标识 | ||
uid | string | false | 设备uid | ||
signalId | int64 | false | 信号id | ||
field | string | false | 属性 | ||
fieldName | string | false | No comments found. | ||
collectTaskId | int64 | false | 采集任务标识 | ||
address | string | false | 采集地址 | ||
value | string | false | 采集值 | ||
status | boolean | false | 采集状态 | ||
reason | string | false | 采集状态说明 | ||
collectMode | string | false | 采集方式 | ||
collectTime | string | false | 采集时间 | ||
createTime | string | false | 创建时间 | ||
collectStatus | enum | false | 采集状态 | ||
productTypeId | int64 | false | 产品类型id | ||
productId | int64 | false | 产品id | ||
deviceSn | string | false | 设备编号 | ||
deviceName | string | false | 设备名称 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─fieldId | int64 | 采集字段id | - |
└─taskId | int64 | 所属任务(可空) | - |
└─protocolCode | string | 协议码 | - |
└─productCode | string | 产品码 | - |
└─deviceGroupId | int64 | 设备组 | - |
└─cid | string | 任务执行标识 | - |
└─uid | string | 设备uid | - |
└─signalId | int64 | 信号id | - |
└─field | string | 属性 | - |
└─fieldName | string | No comments found. | - |
└─collectTaskId | int64 | 采集任务标识 | - |
└─address | string | 采集地址 | - |
└─value | string | 采集值 | - |
└─status | boolean | 采集状态 | - |
└─reason | string | 采集状态说明 | - |
└─collectMode | string | 采集方式 | - |
└─collectTime | string | 采集时间 | - |
└─createTime | string | 创建时间 | - |
└─collectStatus | enum | 采集状态 | - |
└─productTypeId | int64 | 产品类型id | - |
└─productId | int64 | 产品id | - |
└─deviceSn | string | 设备编号 | - |
└─deviceName | string | 设备名称 | - |
└─total | int64 | No comments found. | - |
└─size | int64 | No comments found. | - |
└─current | int64 | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"records": [
{
"id": 0,
"fieldId": 0,
"taskId": 0,
"protocolCode": "",
"productCode": "",
"deviceGroupId": 0,
"cid": "",
"uid": "",
"signalId": 0,
"field": "",
"fieldName": "",
"collectTaskId": 0,
"address": "",
"value": "",
"status": true,
"reason": "",
"collectMode": "",
"collectTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"collectStatus": "Success",
"productTypeId": 0,
"productId": 0,
"deviceSn": "",
"deviceName": ""
}
],
"total": 0,
"size": 0,
"current": 0
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/collectData/model?size=0¤t=0&id=0&fieldId=0&taskId=0&deviceGroupId=0&signalId=0&collectTaskId=0&status=true&collectTime=yyyy-MM-dd HH:mm:ss&createTime=yyyy-MM-dd HH:mm:ss&collectStatus=Success&productTypeId=0&productId=0&total=0&address=&cid=&productCode=&uid=&collectMode=&reason=&pages=0&value=&countId=&field=&deviceSn=&hitCount=true&maxLimit=0&deviceName=&fieldName=&protocolCode=&isSearchCount=true&optimizeCountSql=true'2.2. 采集详情管理
2.2.1. 获取采集详情
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取采集详情
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
extend | string | false | 扩展字段 | ||
storeUid | int64 | false | 存储设备uid | ||
storeAction | string | false | 存储动作 | ||
collectTaskId | int64 | false | 采集任务id | ||
pointGroupId | int64 | false | 点位组 | ||
createTime | string | false | 创建时间 | ||
signalNum | int32 | false | 点位组点位数量 | ||
pointGroupName | string | false | 点位组名称 | ||
collectTaskName | string | false | 任务名称 | ||
devices | array | false | 采集的设备列表 | ||
└─pointGroupId | int64 | false | 点位组id | ||
└─uid | int64 | false | 设备uid | ||
└─deviceSn | string | false | 设备编号 | ||
└─parentDeviceSn | string | false | 父设备编号 | ||
└─productId | string | false | 设备绑定的产品id | ||
└─productCode | string | false | 产品代码 | ||
└─productName | string | false | 设备绑定的产品名称 | ||
└─protocolCode | string | false | 设备使用的协议代码 | ||
└─protocolName | string | false | 设备使用的协议 | ||
└─signals | array | false | 采集的点位信息 | ||
└─id | int64 | false | 点位id | ||
└─name | string | false | 点位名称 | ||
└─address | string | false | 点位地址 | ||
└─fieldName | string | false | 字段名称 | ||
└─num | int32 | false | 寄存器数量 | ||
└─direct | string | false | 协议指令 | ||
└─productId | int64 | false | 所属产品 | ||
└─pointGroupId | int64 | false | 点位组id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─extend | string | 扩展字段 | - |
└─storeUid | int64 | 存储设备uid | - |
└─storeAction | string | 存储动作 | - |
└─collectTaskId | int64 | 采集任务id | - |
└─pointGroupId | int64 | 点位组 | - |
└─createTime | string | 创建时间 | - |
└─signalNum | int32 | 点位组点位数量 | - |
└─pointGroupName | string | 点位组名称 | - |
└─collectTaskName | string | 任务名称 | - |
└─devices | array | 采集的设备列表 | - |
└─pointGroupId | int64 | 点位组id | - |
└─uid | int64 | 设备uid | - |
└─deviceSn | string | 设备编号 | - |
└─parentDeviceSn | string | 父设备编号 | - |
└─productId | string | 设备绑定的产品id | - |
└─productCode | string | 产品代码 | - |
└─productName | string | 设备绑定的产品名称 | - |
└─protocolCode | string | 设备使用的协议代码 | - |
└─protocolName | string | 设备使用的协议 | - |
└─signals | array | 采集的点位信息 | - |
└─id | int64 | 点位id | - |
└─name | string | 点位名称 | - |
└─address | string | 点位地址 | - |
└─fieldName | string | 字段名称 | - |
└─num | int32 | 寄存器数量 | - |
└─direct | string | 协议指令 | - |
└─productId | int64 | 所属产品 | - |
└─pointGroupId | int64 | 点位组id | - |
└─total | int64 | No comments found. | - |
└─size | int64 | No comments found. | - |
└─current | int64 | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"records": [
{
"id": 0,
"extend": "",
"storeUid": 0,
"storeAction": "",
"collectTaskId": 0,
"pointGroupId": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"signalNum": 0,
"pointGroupName": "",
"collectTaskName": "",
"devices": [
{
"pointGroupId": 0,
"uid": 0,
"deviceSn": "",
"parentDeviceSn": "",
"productId": "",
"productCode": "",
"productName": "",
"protocolCode": "",
"protocolName": "",
"signals": [
{
"id": 0,
"name": "",
"address": "",
"fieldName": "",
"num": 0,
"direct": "",
"productId": 0,
"pointGroupId": 0
}
]
}
]
}
],
"total": 0,
"size": 0,
"current": 0
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/collectDetail/details?size=0¤t=0&id=0&storeUid=0&collectTaskId=0&pointGroupId=0&createTime=yyyy-MM-dd HH:mm:ss&signalNum=0&uid=0&num=0&productId=0&total=0&extend=&devices[0].productName=&collectTaskName=&devices[0].signals[0].id=0&maxLimit=0&devices[0].protocolName=&isSearchCount=true&devices[0].signals[0].num=0&devices[0].signals[0].pointGroupId=0&devices[0].parentDeviceSn=&devices[0].signals[0].address=&devices[0].signals[0].name=&devices[0].signals[0].fieldName=&devices[0].uid=0&devices[0].deviceSn=&devices[0].pointGroupId=0&devices[0].productCode=&pointGroupName=&devices[0].protocolCode=&devices[0].signals[0].direct=&hitCount=true&optimizeCountSql=true&countId=&storeAction=&pages=0&devices[0].signals[0].productId=0&devices[0].productId='2.2.2. 新增或者更新记录
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 新增或者更新记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─extend | string | 扩展字段 | - |
└─storeUid | int64 | 存储设备uid | - |
└─storeAction | string | 存储动作 | - |
└─collectTaskId | int64 | 采集任务id | - |
└─pointGroupId | int64 | 点位组 | - |
└─createTime | string | 创建时间 | - |
└─signalNum | int32 | 点位组点位数量 | - |
└─pointGroupName | string | 点位组名称 | - |
└─collectTaskName | string | 任务名称 | - |
└─devices | array | 采集的设备列表 | - |
└─pointGroupId | int64 | 点位组id | - |
└─uid | int64 | 设备uid | - |
└─deviceSn | string | 设备编号 | - |
└─parentDeviceSn | string | 父设备编号 | - |
└─productId | string | 设备绑定的产品id | - |
└─productCode | string | 产品代码 | - |
└─productName | string | 设备绑定的产品名称 | - |
└─protocolCode | string | 设备使用的协议代码 | - |
└─protocolName | string | 设备使用的协议 | - |
└─signals | array | 采集的点位信息 | - |
└─id | int64 | 点位id | - |
└─name | string | 点位名称 | - |
└─address | string | 点位地址 | - |
└─fieldName | string | 字段名称 | - |
└─num | int32 | 寄存器数量 | - |
└─direct | string | 协议指令 | - |
└─productId | int64 | 所属产品 | - |
└─pointGroupId | int64 | 点位组id | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"extend": "",
"storeUid": 0,
"storeAction": "",
"collectTaskId": 0,
"pointGroupId": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"signalNum": 0,
"pointGroupName": "",
"collectTaskName": "",
"devices": [
{
"pointGroupId": 0,
"uid": 0,
"deviceSn": "",
"parentDeviceSn": "",
"productId": "",
"productCode": "",
"productName": "",
"protocolCode": "",
"protocolName": "",
"signals": [
{
"id": 0,
"name": "",
"address": "",
"fieldName": "",
"num": 0,
"direct": "",
"productId": 0,
"pointGroupId": 0
}
]
}
]
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/collectDetail/edit?id=0&=wq9v5a'2.2.3. 新增或者更新记录
Type: POST
Content-Type: application/json
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
extend | string | false | 扩展字段 |
storeUid | int64 | false | 存储设备uid |
storeAction | string | false | 存储动作 |
collectTaskId | int64 | false | 采集任务id |
pointGroupId | int64 | false | 点位组 |
createTime | string | false | 创建时间 |
signalNum | int32 | false | 点位组点位数量 |
pointGroupName | string | false | 点位组名称 |
collectTaskName | string | false | 任务名称 |
devices | array | false | 采集的设备列表 |
└─pointGroupId | int64 | false | 点位组id |
└─uid | int64 | false | 设备uid |
└─deviceSn | string | false | 设备编号 |
└─parentDeviceSn | string | false | 父设备编号 |
└─productId | string | false | 设备绑定的产品id |
└─productCode | string | false | 产品代码 |
└─productName | string | false | 设备绑定的产品名称 |
└─protocolCode | string | false | 设备使用的协议代码 |
└─protocolName | string | false | 设备使用的协议 |
└─signals | array | false | 采集的点位信息 |
└─id | int64 | false | 点位id |
└─name | string | false | 点位名称 |
└─address | string | false | 点位地址 |
└─fieldName | string | false | 字段名称 |
└─num | int32 | false | 寄存器数量 |
└─direct | string | false | 协议指令 |
└─productId | int64 | false | 所属产品 |
└─pointGroupId | int64 | false | 点位组id |
Request-body:
{
"id": 0,
"extend": "",
"storeUid": 0,
"storeAction": "",
"collectTaskId": 0,
"pointGroupId": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"signalNum": 0,
"pointGroupName": "",
"collectTaskName": "",
"devices": [
{
"pointGroupId": 0,
"uid": 0,
"deviceSn": "",
"parentDeviceSn": "",
"productId": "",
"productCode": "",
"productName": "",
"protocolCode": "",
"protocolName": "",
"signals": [
{
"id": 0,
"name": "",
"address": "",
"fieldName": "",
"num": 0,
"direct": "",
"productId": 0,
"pointGroupId": 0
}
]
}
]
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/collectDetail/saveOrUpdate' --data '{
"id": 0,
"extend": "",
"storeUid": 0,
"storeAction": "",
"collectTaskId": 0,
"pointGroupId": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"signalNum": 0,
"pointGroupName": "",
"collectTaskName": "",
"devices": [
{
"pointGroupId": 0,
"uid": 0,
"deviceSn": "",
"parentDeviceSn": "",
"productId": "",
"productCode": "",
"productName": "",
"protocolCode": "",
"protocolName": "",
"signals": [
{
"id": 0,
"name": "",
"address": "",
"fieldName": "",
"num": 0,
"direct": "",
"productId": 0,
"pointGroupId": 0
}
]
}
]
}'2.2.4. 删除指定记录
Type: POST
Content-Type: application/json
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/collectDetail/del' --data '[
0
]'2.3. 数据采集任务管理
2.3.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
name | string | true | 任务名称 | ||
cron | string | true | 任务调度 | ||
status | string | false | 任务状态 | ||
remark | string | false | 采集任务说明 | ||
reason | string | false | 任务失败的原因 | ||
createTime | string | false | 创建时间 | ||
updateTime | string | false | 更新时间 | ||
pointGroupId | int64 | false | 点位组 | ||
details | array | false | 点位列表 | ||
└─id | int64 | false | No comments found. | ||
└─extend | string | false | 扩展字段 | ||
└─storeUid | int64 | false | 存储设备uid | ||
└─storeAction | string | false | 存储动作 | ||
└─collectTaskId | int64 | false | 采集任务id | ||
└─pointGroupId | int64 | false | 点位组 | ||
└─createTime | string | false | 创建时间 | ||
└─signalNum | int32 | false | 点位组点位数量 | ||
└─pointGroupName | string | false | 点位组名称 | ||
└─collectTaskName | string | false | 任务名称 | ||
└─devices | array | false | 采集的设备列表 | ||
└─pointGroupId | int64 | false | 点位组id | ||
└─uid | int64 | false | 设备uid | ||
└─deviceSn | string | false | 设备编号 | ||
└─parentDeviceSn | string | false | 父设备编号 | ||
└─productId | string | false | 设备绑定的产品id | ||
└─productCode | string | false | 产品代码 | ||
└─productName | string | false | 设备绑定的产品名称 | ||
└─protocolCode | string | false | 设备使用的协议代码 | ||
└─protocolName | string | false | 设备使用的协议 | ||
└─signals | array | false | 采集的点位信息 | ||
└─id | int64 | false | 点位id | ||
└─name | string | false | 点位名称 | ||
└─address | string | false | 点位地址 | ||
└─fieldName | string | false | 字段名称 | ||
└─num | int32 | false | 寄存器数量 | ||
└─direct | string | false | 协议指令 | ||
└─productId | int64 | false | 所属产品 | ||
└─pointGroupId | int64 | false | 点位组id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─name | string | 任务名称 | - |
└─cron | string | 任务调度 | - |
└─status | string | 任务状态 | - |
└─remark | string | 采集任务说明 | - |
└─reason | string | 任务失败的原因 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
└─pointGroupId | int64 | 点位组 | - |
└─details | array | 点位列表 | - |
└─id | int64 | No comments found. | - |
└─extend | string | 扩展字段 | - |
└─storeUid | int64 | 存储设备uid | - |
└─storeAction | string | 存储动作 | - |
└─collectTaskId | int64 | 采集任务id | - |
└─pointGroupId | int64 | 点位组 | - |
└─createTime | string | 创建时间 | - |
└─signalNum | int32 | 点位组点位数量 | - |
└─pointGroupName | string | 点位组名称 | - |
└─collectTaskName | string | 任务名称 | - |
└─devices | array | 采集的设备列表 | - |
└─pointGroupId | int64 | 点位组id | - |
└─uid | int64 | 设备uid | - |
└─deviceSn | string | 设备编号 | - |
└─parentDeviceSn | string | 父设备编号 | - |
└─productId | string | 设备绑定的产品id | - |
└─productCode | string | 产品代码 | - |
└─productName | string | 设备绑定的产品名称 | - |
└─protocolCode | string | 设备使用的协议代码 | - |
└─protocolName | string | 设备使用的协议 | - |
└─signals | array | 采集的点位信息 | - |
└─id | int64 | 点位id | - |
└─name | string | 点位名称 | - |
└─address | string | 点位地址 | - |
└─fieldName | string | 字段名称 | - |
└─num | int32 | 寄存器数量 | - |
└─direct | string | 协议指令 | - |
└─productId | int64 | 所属产品 | - |
└─pointGroupId | int64 | 点位组id | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"name": "",
"cron": "",
"status": "",
"remark": "",
"reason": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"pointGroupId": 0,
"details": [
{
"id": 0,
"extend": "",
"storeUid": 0,
"storeAction": "",
"collectTaskId": 0,
"pointGroupId": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"signalNum": 0,
"pointGroupName": "",
"collectTaskName": "",
"devices": [
{
"pointGroupId": 0,
"uid": 0,
"deviceSn": "",
"parentDeviceSn": "",
"productId": "",
"productCode": "",
"productName": "",
"protocolCode": "",
"protocolName": "",
"signals": [
{
"id": 0,
"name": "",
"address": "",
"fieldName": "",
"num": 0,
"direct": "",
"productId": 0,
"pointGroupId": 0
}
]
}
]
}
]
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/collectTask/view?size=0¤t=0&id=0&createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&pointGroupId=0&storeUid=0&collectTaskId=0&signalNum=0&uid=0&num=0&productId=0&orders[0].details[0].devices[0].protocolCode=&details[0].devices[0].signals[0].address=&records[0].details[0].devices[0].parentDeviceSn=&records[0].details[0].id=0&details[0].devices[0].protocolName=&orders[0].details[0].createTime=yyyy-MM-dd HH:mm:ss&records[0].status=&orders[0].details[0].devices[0].signals[0].name=&records[0].createTime=yyyy-MM-dd HH:mm:ss&optimizeCountSql=true&orders[0].pointGroupId=0&orders[0].details[0].devices[0].productName=&records[0].id=0&orders[0].details[0].devices[0].signals[0].num=0&orders[0].id=0&details[0].devices[0].uid=0&details[0].devices[0].productId=&records[0].details[0].storeUid=0&records[0].details[0].storeAction=&records[0].details[0].devices[0].signals[0].direct=&details[0].devices[0].signals[0].id=0&details[0].devices[0].productName=&records[0].reason=&records[0].details[0].devices[0].deviceSn=&countId=&records[0].details[0].createTime=yyyy-MM-dd HH:mm:ss&cron=&orders[0].details[0].devices[0].signals[0].productId=0&orders[0].details[0].devices[0].signals[0].pointGroupId=0&records[0].details[0].devices[0].signals[0].name=&details[0].devices[0].signals[0].productId=0&orders[0].createTime=yyyy-MM-dd HH:mm:ss&details[0].storeAction=&orders[0].details[0].devices[0].deviceSn=&details[0].devices[0].signals[0].pointGroupId=0&orders[0].status=&details[0].extend=&orders[0].details[0].pointGroupId=0&orders[0].details[0].devices[0].signals[0].direct=&records[0].details[0].devices[0].productName=&records[0].details[0].devices[0].pointGroupId=0&orders[0].details[0].devices[0].protocolName=&pages=0&details[0].devices[0].protocolCode=&details[0].devices[0].signals[0].direct=&records[0].details[0].pointGroupName=&records[0].details[0].devices[0].protocolCode=&details[0].pointGroupId=0&orders[0].remark=&reason=&records[0].details[0].devices[0].productCode=&records[0].details[0].extend=&orders[0].details[0].devices[0].parentDeviceSn=&orders[0].details[0].devices[0].uid=0&records[0].details[0].signalNum=0&hitCount=true&status=&remark=&orders[0].details[0].collectTaskName=&records[0].details[0].devices[0].signals[0].pointGroupId=0&details[0].createTime=yyyy-MM-dd HH:mm:ss&orders[0].details[0].devices[0].productCode=&orders[0].reason=&details[0].devices[0].deviceSn=&records[0].details[0].devices[0].signals[0].num=0&orders[0].details[0].collectTaskId=0&records[0].details[0].collectTaskName=&orders[0].details[0].extend=&details[0].storeUid=0&orders[0].details[0].devices[0].signals[0].id=0&details[0].devices[0].signals[0].num=0&records[0].details[0].devices[0].signals[0].productId=0&records[0].details[0].collectTaskId=0&orders[0].details[0].devices[0].signals[0].fieldName=&orders[0].updateTime=yyyy-MM-dd HH:mm:ss&total=0&orders[0].details[0].devices[0].signals[0].address=&details[0].collectTaskId=0&records[0].cron=&orders[0].details[0].pointGroupName=&orders[0].details[0].devices[0].productId=&details[0].collectTaskName=&details[0].devices[0].parentDeviceSn=&records[0].updateTime=yyyy-MM-dd HH:mm:ss&records[0].pointGroupId=0&isSearchCount=true&details[0].signalNum=0&orders[0].details[0].devices[0].pointGroupId=0&records[0].remark=&records[0].details[0].devices[0].signals[0].fieldName=&records[0].details[0].pointGroupId=0&name=&details[0].devices[0].signals[0].fieldName=&records[0].name=&details[0].devices[0].pointGroupId=0&details[0].devices[0].productCode=&details[0].pointGroupName=&records[0].details[0].devices[0].signals[0].id=0&orders[0].details[0].storeAction=&orders[0].cron=&details[0].id=0&maxLimit=0&records[0].details[0].devices[0].protocolName=&records[0].details[0].devices[0].signals[0].address=&details[0].devices[0].signals[0].name=&orders[0].details[0].storeUid=0&records[0].details[0].devices[0].uid=0&records[0].details[0].devices[0].productId=&orders[0].name=&orders[0].details[0].id=0&orders[0].details[0].signalNum=0'2.3.2. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | 记录id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─name | string | 任务名称 | - |
└─cron | string | 任务调度 | - |
└─status | string | 任务状态 | - |
└─remark | string | 采集任务说明 | - |
└─reason | string | 任务失败的原因 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
└─pointGroupId | int64 | 点位组 | - |
└─details | array | 点位列表 | - |
└─id | int64 | No comments found. | - |
└─extend | string | 扩展字段 | - |
└─storeUid | int64 | 存储设备uid | - |
└─storeAction | string | 存储动作 | - |
└─collectTaskId | int64 | 采集任务id | - |
└─pointGroupId | int64 | 点位组 | - |
└─createTime | string | 创建时间 | - |
└─signalNum | int32 | 点位组点位数量 | - |
└─pointGroupName | string | 点位组名称 | - |
└─collectTaskName | string | 任务名称 | - |
└─devices | array | 采集的设备列表 | - |
└─pointGroupId | int64 | 点位组id | - |
└─uid | int64 | 设备uid | - |
└─deviceSn | string | 设备编号 | - |
└─parentDeviceSn | string | 父设备编号 | - |
└─productId | string | 设备绑定的产品id | - |
└─productCode | string | 产品代码 | - |
└─productName | string | 设备绑定的产品名称 | - |
└─protocolCode | string | 设备使用的协议代码 | - |
└─protocolName | string | 设备使用的协议 | - |
└─signals | array | 采集的点位信息 | - |
└─id | int64 | 点位id | - |
└─name | string | 点位名称 | - |
└─address | string | 点位地址 | - |
└─fieldName | string | 字段名称 | - |
└─num | int32 | 寄存器数量 | - |
└─direct | string | 协议指令 | - |
└─productId | int64 | 所属产品 | - |
└─pointGroupId | int64 | 点位组id | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"name": "",
"cron": "",
"status": "",
"remark": "",
"reason": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"pointGroupId": 0,
"details": [
{
"id": 0,
"extend": "",
"storeUid": 0,
"storeAction": "",
"collectTaskId": 0,
"pointGroupId": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"signalNum": 0,
"pointGroupName": "",
"collectTaskName": "",
"devices": [
{
"pointGroupId": 0,
"uid": 0,
"deviceSn": "",
"parentDeviceSn": "",
"productId": "",
"productCode": "",
"productName": "",
"protocolCode": "",
"protocolName": "",
"signals": [
{
"id": 0,
"name": "",
"address": "",
"fieldName": "",
"num": 0,
"direct": "",
"productId": 0,
"pointGroupId": 0
}
]
}
]
}
]
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/collectTask/edit?id=0&=fev21j'2.3.3. 新增或者更新记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
name | string | true | 任务名称 |
cron | string | true | 任务调度 |
status | string | false | 任务状态 |
remark | string | false | 采集任务说明 |
reason | string | false | 任务失败的原因 |
createTime | string | false | 创建时间 |
updateTime | string | false | 更新时间 |
Request-body:
{
"id": 0,
"name": "",
"cron": "",
"status": "",
"remark": "",
"reason": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/collectTask/saveOrUpdate' --data '{
"id": 0,
"name": "",
"cron": "",
"status": "",
"remark": "",
"reason": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}'2.3.4. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/collectTask/del' --data '[
0
]'2.3.5. 切换采集状态
Type: POST
Author: iteaj
Content-Type: application/json
Description: 切换采集状态
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
name | string | true | 任务名称 |
cron | string | true | 任务调度 |
status | string | false | 任务状态 |
remark | string | false | 采集任务说明 |
reason | string | false | 任务失败的原因 |
createTime | string | false | 创建时间 |
updateTime | string | false | 更新时间 |
Request-body:
{
"id": 0,
"name": "",
"cron": "",
"status": "",
"remark": "",
"reason": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/collectTask/status' --data '{
"id": 0,
"name": "",
"cron": "",
"status": "",
"remark": "",
"reason": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}'2.3.6. 采集任务列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 采集任务列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. | ||
name | string | true | 任务名称 | ||
cron | string | true | 任务调度 | ||
status | string | false | 任务状态 | ||
remark | string | false | 采集任务说明 | ||
reason | string | false | 任务失败的原因 | ||
createTime | string | false | 创建时间 | ||
updateTime | string | false | 更新时间 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─name | string | 任务名称 | - |
└─cron | string | 任务调度 | - |
└─status | string | 任务状态 | - |
└─remark | string | 采集任务说明 | - |
└─reason | string | 任务失败的原因 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"name": "",
"cron": "",
"status": "",
"remark": "",
"reason": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/collectTask/list?id=0&createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&status=&remark=&cron=&reason=&name='2.3.7. 存储动作
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 存储动作
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─label | string | No comments found. | - |
└─value | string | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"label": "",
"value": ""
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/collectTask/storeActions'2.4. 子设备管理
2.4.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
name | string | false | 子设备名称 | ||
uid | int64 | false | 设备uid | ||
childSn | string | false | 子设备编号 | ||
protocolType | string | false | 协议类型 | ||
remark | string | false | 备注 | ||
createTime | string | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─name | string | 子设备名称 | - |
└─uid | int64 | 设备uid | - |
└─childSn | string | 子设备编号 | - |
└─protocolType | string | 协议类型 | - |
└─remark | string | 备注 | - |
└─createTime | string | No comments found. | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"name": "",
"uid": 0,
"childSn": "",
"protocolType": "",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss"
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/deviceChild/view?size=0¤t=0&id=0&uid=0&createTime=yyyy-MM-dd HH:mm:ss&maxLimit=0&records[0].childSn=&records[0].uid=0&protocolType=&orders[0].childSn=&orders[0].name=&optimizeCountSql=true&countId=&childSn=&orders[0].id=0&orders[0].uid=0&orders[0].remark=&records[0].createTime=yyyy-MM-dd HH:mm:ss&orders[0].protocolType=&remark=&orders[0].createTime=yyyy-MM-dd HH:mm:ss&total=0&records[0].id=0&records[0].name=&name=&records[0].protocolType=&records[0].remark=&isSearchCount=true&pages=0&hitCount=true'2.4.2. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | 记录id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─name | string | 子设备名称 | - |
└─uid | int64 | 设备uid | - |
└─childSn | string | 子设备编号 | - |
└─protocolType | string | 协议类型 | - |
└─remark | string | 备注 | - |
└─createTime | string | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"name": "",
"uid": 0,
"childSn": "",
"protocolType": "",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss"
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/deviceChild/edit?id=0&=0majtq'2.4.3. 新增或者更新记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
name | string | false | 子设备名称 |
uid | int64 | false | 设备uid |
childSn | string | false | 子设备编号 |
protocolType | string | false | 协议类型 |
remark | string | false | 备注 |
createTime | string | false | No comments found. |
Request-body:
{
"id": 0,
"name": "",
"uid": 0,
"childSn": "",
"protocolType": "",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/deviceChild/saveOrUpdate' --data '{
"id": 0,
"name": "",
"uid": 0,
"childSn": "",
"protocolType": "",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss"
}'2.4.4. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/deviceChild/del' --data '[
0
]'2.4.5. 或者指定设备下的子设备列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 或者指定设备下的子设备列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
uid | int64 | false | 设备uid |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─name | string | 子设备名称 | - |
└─uid | int64 | 设备uid | - |
└─childSn | string | 子设备编号 | - |
└─protocolType | string | 协议类型 | - |
└─remark | string | 备注 | - |
└─createTime | string | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"name": "",
"uid": 0,
"childSn": "",
"protocolType": "",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss"
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/deviceChild/listByUid?uid=0&=yy3vji'2.5. 设备管理
2.5.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
ip | string | false | 设备ip | ||
pid | int64 | false | 父网关设备 | ||
uid | string | false | 设备uid | ||
name | string | true | 设备名称 | ||
port | int32 | false | 设备端口 | ||
extend | string | false | 拓展字段 | ||
productId | int64 | true | 所属产品 | ||
deviceGroupId | int64 | false | 所属组 | ||
productTypeId | int64 | false | 设备类型 | ||
lon | string | false | 经度 | ||
lat | string | false | 纬度 | ||
address | string | false | 地址 | ||
account | string | false | 设备账号 | ||
password | string | false | 设备密码 | ||
status | enum | false | 设备状态 | ||
deviceSn | string | true | 设备编号 | ||
parentDeviceSn | string | false | 父设备编号 | ||
config | object | false | 设备配置 | ||
└─map | map | false | No comments found. | ||
└─any object | object | false | any object. | ||
switchTime | string | false | 状态切换时间 | ||
createTime | string | false | 新增时间 | ||
updateTime | string | false | 更新时间 | ||
deviceType | enum | false | 设备类型 | ||
gatewayId | int64 | false | 所属网关 | ||
gatewayName | string | false | 网关名称 | ||
connectType | enum | false | 连接类型 | ||
productCode | string | false | 产品代码 | ||
productName | string | false | 产品名称 | ||
protocolCode | string | false | 协议码 | ||
productTypeName | string | false | 产品类型名称 | ||
deviceGroupName | string | false | 所属分组 | ||
alias | enum | false | 设备别名 | ||
protocolCodes | array | false | 协议码列表 | ||
protocol | enum | false | 协议类型 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─ip | string | 设备ip | - |
└─pid | int64 | 父网关设备 | - |
└─uid | string | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─extend | string | 拓展字段 | - |
└─productId | int64 | 所属产品 | - |
└─deviceGroupId | int64 | 所属组 | - |
└─productTypeId | int64 | 设备类型 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─parentDeviceSn | string | 父设备编号 | - |
└─config | object | 设备配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | 新增时间 | - |
└─updateTime | string | 更新时间 | - |
└─deviceType | enum | 设备类型 | - |
└─gatewayId | int64 | 所属网关 | - |
└─gatewayName | string | 网关名称 | - |
└─connectType | enum | 连接类型 | - |
└─productCode | string | 产品代码 | - |
└─productName | string | 产品名称 | - |
└─protocolCode | string | 协议码 | - |
└─productTypeName | string | 产品类型名称 | - |
└─deviceGroupName | string | 所属分组 | - |
└─alias | enum | 设备别名 | - |
└─protocolCodes | array | 协议码列表 | - |
└─protocol | enum | 协议类型 | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"deviceType": "Direct",
"gatewayId": 0,
"gatewayName": "",
"connectType": "Client",
"productCode": "",
"productName": "",
"protocolCode": "",
"productTypeName": "",
"deviceGroupName": "",
"alias": "PLC",
"protocolCodes": [
""
],
"protocol": "TCP"
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/device/view?size=0¤t=0&id=0&pid=0&port=0&productId=0&deviceGroupId=0&productTypeId=0&status=online&switchTime=yyyy-MM-dd HH:mm:ss&createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&deviceType=Direct&gatewayId=0&connectType=Client&alias=PLC&protocolCodes=,&protocol=TCP&orders[0].password=&isSearchCount=true&records[0].pid=0&records[0].address=&total=0&orders[0].ip=&extend=&records[0].uid=&records[0].account=&uid=&maxLimit=0&ip=&orders[0].account=&lat=&records[0].extend=&records[0].status=online&parentDeviceSn=&orders[0].uid=&productName=&protocolCode=&records[0].switchTime=yyyy-MM-dd HH:mm:ss&orders[0].id=0&pages=0&records[0].deviceSn=&records[0].productId=0&orders[0].productId=0&countId=&name=&orders[0].lon=&address=&password=&records[0].deviceGroupId=0&orders[0].lat=&records[0].createTime=yyyy-MM-dd HH:mm:ss&records[0].id=0&records[0].lon=&orders[0].pid=0&orders[0].port=0&records[0].ip=&records[0].lat=&lon=&productTypeName=&records[0].parentDeviceSn=&orders[0].address=&deviceSn=&records[0].productTypeId=0&optimizeCountSql=true&records[0].name=&orders[0].extend=&orders[0].createTime=yyyy-MM-dd HH:mm:ss&hitCount=true&productCode=&account=&records[0].password=&records[0].updateTime=yyyy-MM-dd HH:mm:ss&deviceGroupName=&orders[0].deviceSn=&orders[0].deviceGroupId=0&orders[0].status=online&gatewayName=&records[0].port=0&orders[0].parentDeviceSn=&orders[0].name=&orders[0].productTypeId=0&orders[0].updateTime=yyyy-MM-dd HH:mm:ss&orders[0].switchTime=yyyy-MM-dd HH:mm:ss'2.5.2. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | 记录id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─ip | string | 设备ip | - |
└─pid | int64 | 父网关设备 | - |
└─uid | string | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─extend | string | 拓展字段 | - |
└─productId | int64 | 所属产品 | - |
└─deviceGroupId | int64 | 所属组 | - |
└─productTypeId | int64 | 设备类型 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─parentDeviceSn | string | 父设备编号 | - |
└─config | object | 设备配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | 新增时间 | - |
└─updateTime | string | 更新时间 | - |
└─deviceType | enum | 设备类型 | - |
└─gatewayId | int64 | 所属网关 | - |
└─gatewayName | string | 网关名称 | - |
└─connectType | enum | 连接类型 | - |
└─productCode | string | 产品代码 | - |
└─productName | string | 产品名称 | - |
└─protocolCode | string | 协议码 | - |
└─productTypeName | string | 产品类型名称 | - |
└─deviceGroupName | string | 所属分组 | - |
└─alias | enum | 设备别名 | - |
└─protocolCodes | array | 协议码列表 | - |
└─protocol | enum | 协议类型 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"deviceType": "Direct",
"gatewayId": 0,
"gatewayName": "",
"connectType": "Client",
"productCode": "",
"productName": "",
"protocolCode": "",
"productTypeName": "",
"deviceGroupName": "",
"alias": "PLC",
"protocolCodes": [
""
],
"protocol": "TCP"
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/device/edit?id=0&=wto14u'2.5.3. 修改记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 修改记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
ip | string | false | 设备ip |
pid | int64 | false | 父网关设备 |
uid | string | false | 设备uid |
name | string | true | 设备名称 |
port | int32 | false | 设备端口 |
extend | string | false | 拓展字段 |
productId | int64 | true | 所属产品 |
deviceGroupId | int64 | false | 所属组 |
productTypeId | int64 | false | 设备类型 |
lon | string | false | 经度 |
lat | string | false | 纬度 |
address | string | false | 地址 |
account | string | false | 设备账号 |
password | string | false | 设备密码 |
status | enum | false | 设备状态 |
deviceSn | string | true | 设备编号 |
parentDeviceSn | string | false | 父设备编号 |
config | object | false | 设备配置 |
└─map | map | false | No comments found. |
└─any object | object | false | any object. |
switchTime | string | false | 状态切换时间 |
createTime | string | false | 新增时间 |
updateTime | string | false | 更新时间 |
Request-body:
{
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/device/edit' --data '{
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}'2.5.4. 新增记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
ip | string | false | 设备ip |
pid | int64 | false | 父网关设备 |
uid | string | false | 设备uid |
name | string | true | 设备名称 |
port | int32 | false | 设备端口 |
extend | string | false | 拓展字段 |
productId | int64 | true | 所属产品 |
deviceGroupId | int64 | false | 所属组 |
productTypeId | int64 | false | 设备类型 |
lon | string | false | 经度 |
lat | string | false | 纬度 |
address | string | false | 地址 |
account | string | false | 设备账号 |
password | string | false | 设备密码 |
status | enum | false | 设备状态 |
deviceSn | string | true | 设备编号 |
parentDeviceSn | string | false | 父设备编号 |
config | object | false | 设备配置 |
└─map | map | false | No comments found. |
└─any object | object | false | any object. |
switchTime | string | false | 状态切换时间 |
createTime | string | false | 新增时间 |
updateTime | string | false | 更新时间 |
Request-body:
{
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/device/add' --data '{
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}'2.5.5. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/device/del' --data '[
0
]'2.5.6. 获取指定型号下面的设备列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取指定型号下面的设备列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
modelId | int64 | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─ip | string | 设备ip | - |
└─pid | int64 | 父网关设备 | - |
└─uid | string | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─extend | string | 拓展字段 | - |
└─productId | int64 | 所属产品 | - |
└─deviceGroupId | int64 | 所属组 | - |
└─productTypeId | int64 | 设备类型 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─parentDeviceSn | string | 父设备编号 | - |
└─config | object | 设备配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | 新增时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/device/listByModel?modelId=0&=hn8o96'2.5.7. 获取网关设备
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取网关设备
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
gatewayId | int64 | false | 网关id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─ip | string | 设备ip | - |
└─pid | int64 | 父网关设备 | - |
└─uid | string | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─extend | string | 拓展字段 | - |
└─productId | int64 | 所属产品 | - |
└─deviceGroupId | int64 | 所属组 | - |
└─productTypeId | int64 | 设备类型 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─parentDeviceSn | string | 父设备编号 | - |
└─config | object | 设备配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | 新增时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/device/listOfGateway?gatewayId=0&=wggwtb'2.5.8. 获取指定产品列表下的所有设备
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取指定产品列表下的所有设备
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
productIds | array | false | No comments found.,[array of int64] |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─ip | string | 设备ip | - |
└─pid | int64 | 父网关设备 | - |
└─uid | string | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─extend | string | 拓展字段 | - |
└─productId | int64 | 所属产品 | - |
└─deviceGroupId | int64 | 所属组 | - |
└─productTypeId | int64 | 设备类型 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─parentDeviceSn | string | 父设备编号 | - |
└─config | object | 设备配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | 新增时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/device/listOfProducts?productIds=1763pl&productIds=1763pl'2.5.9. 设备连接
Type: POST
Author: iteaj
Content-Type: application/json
Description: 设备连接
Path-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
status | enum | true | online, offline |
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
ip | string | false | 设备ip |
pid | int64 | false | 父网关设备 |
uid | string | false | 设备uid |
name | string | true | 设备名称 |
port | int32 | false | 设备端口 |
extend | string | false | 拓展字段 |
productId | int64 | true | 所属产品 |
deviceGroupId | int64 | false | 所属组 |
productTypeId | int64 | false | 设备类型 |
lon | string | false | 经度 |
lat | string | false | 纬度 |
address | string | false | 地址 |
account | string | false | 设备账号 |
password | string | false | 设备密码 |
status | enum | false | 设备状态 |
deviceSn | string | true | 设备编号 |
parentDeviceSn | string | false | 父设备编号 |
config | object | false | 设备配置 |
└─map | map | false | No comments found. |
└─any object | object | false | any object. |
switchTime | string | false | 状态切换时间 |
createTime | string | false | 新增时间 |
updateTime | string | false | 更新时间 |
Request-body:
{
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/device/connect/{status}' --data '{
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}'2.6. 设备指令接口管理
2.6.1. 设备控制
Type: POST
Content-Type: application/json
Description: 设备控制
Path-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
modelApiCode | string | true | 物模型接口代码 |
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
uid | string | false | 设备uid |
timeout | int64 | false | 超时时间(毫秒) |
param | object | false | 执行参数 |
└─map | map | false | No comments found. |
└─any object | object | false | any object. |
config | map | false | 执行配置 |
└─any object | object | false | any object. |
Request-body:
{
"uid": "",
"timeout": 0,
"param": {
"map": {
"mapKey": {}
}
},
"config": {
"mapKey": {}
}
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/instruct/ctrl/{modelApiCode}' --data '{
"uid": "",
"timeout": 0,
"param": {
"map": {
"mapKey": {}
}
},
"config": {
"mapKey": {}
}
}'2.6.2. 设备调试接口
Type: POST
Content-Type: application/json
Description: 设备调试接口
Path-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
modelApiCode | string | true | No comments found. |
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
uid | string | false | 设备uid |
timeout | int64 | false | 超时时间(毫秒) |
param | object | false | 执行参数 |
└─map | map | false | No comments found. |
└─any object | object | false | any object. |
config | map | false | 执行配置 |
└─any object | object | false | any object. |
Request-body:
{
"uid": "",
"timeout": 0,
"param": {
"map": {
"mapKey": {}
}
},
"config": {
"mapKey": {}
}
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─deviceSn | string | 设备编号 | - |
└─reqTime | int64 | 请求时间 | - |
└─respTime | int64 | 响应时间 | - |
└─value | object | 读的值 写为null | - |
└─reqMsg | string | 请求的十六进制报文 | - |
└─respMsg | string | 响应的十六机制报文 | - |
└─reason | string | 失败原因 | - |
└─status | enum | 执行状态 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"deviceSn": "",
"reqTime": 0,
"respTime": 0,
"value": {
"object": "any object"
},
"reqMsg": "",
"respMsg": "",
"reason": "",
"status": "success"
}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/instruct/debug/{modelApiCode}' --data '{
"uid": "",
"timeout": 0,
"param": {
"map": {
"mapKey": {}
}
},
"config": {
"mapKey": {}
}
}'2.7. 设备调试管理
2.7.1. 产品类型、产品、设备树
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 产品类型、产品、设备树
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
productId | int64 | false | 产品id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | 设备、产品、产品类型id | - |
└─pid | int64 | 父级id | - |
└─type | string | 树节点类型 | - |
└─key | string | 唯一key | - |
└─pkey | string | 父级key | - |
└─name | string | 名称 | - |
└─isLeaf | boolean | 是否叶子节点 | - |
└─status | enum | 设备状态 | - |
└─children | array | 子数据 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"pid": 0,
"type": "",
"key": "",
"pkey": "",
"name": "",
"isLeaf": true,
"status": "online",
"children": [
{
"$ref": ".."
}
]
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/debug/tree?productId=0&=g8yxeb'2.7.2. 调试详情
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 调试详情
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
deviceId | int64 | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─device | object | 设备信息 | - |
└─id | int64 | No comments found. | - |
└─ip | string | 设备ip | - |
└─pid | int64 | 父网关设备 | - |
└─uid | string | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─extend | string | 拓展字段 | - |
└─productId | int64 | 所属产品 | - |
└─deviceGroupId | int64 | 所属组 | - |
└─productTypeId | int64 | 设备类型 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─parentDeviceSn | string | 父设备编号 | - |
└─config | object | 设备配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | 新增时间 | - |
└─updateTime | string | 更新时间 | - |
└─deviceType | enum | 设备类型 | - |
└─gatewayId | int64 | 所属网关 | - |
└─gatewayName | string | 网关名称 | - |
└─connectType | enum | 连接类型 | - |
└─productCode | string | 产品代码 | - |
└─productName | string | 产品名称 | - |
└─protocolCode | string | 协议码 | - |
└─productTypeName | string | 产品类型名称 | - |
└─deviceGroupName | string | 所属分组 | - |
└─alias | enum | 设备别名 | - |
└─protocolCodes | array | 协议码列表 | - |
└─protocol | enum | 协议类型 | - |
└─product | object | 产品信息 | - |
└─id | int64 | No comments found. | - |
└─logo | string | 图标 | - |
└─status | enum | 产品状态 | - |
└─code | string | 产品代码 | - |
└─deviceType | enum | 设备类型 | - |
└─productTypeId | int64 | 产品类型 | - |
└─typeName | string | 类型名称 | - |
└─name | string | 产品名称 | - |
└─parentId | int64 | 父产品id | - |
└─gatewayId | int64 | 绑定的网关 | - |
└─protocolId | int64 | 绑定的协议 | - |
└─config | object | 产品配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─remark | string | 产品说明 | - |
└─createTime | string | 创建时间 | - |
└─gatewayType | enum | 网关类型 | - |
└─gatewayName | string | 网关名称 | - |
└─protocolName | string | 协议名称 | - |
└─protocolCode | string | 协议代码 | - |
└─connectType | enum | 网关连接类型 | - |
└─deviceCount | int32 | 设备数量 | - |
└─ctrlMode | enum | 操作类型 | - |
└─gatewayStatus | enum | 网关状态 | - |
└─transportProtocol | enum | 传输协议 | - |
└─attrs | array | 物模型属性 | - |
└─id | int64 | No comments found. | - |
└─productId | int64 | 所属产品 | - |
└─field | string | 属性代码 | - |
└─name | string | 属性名称 | - |
└─dataType | string | 数据类型 | - |
└─realType | string | 实际类型 | - |
└─attrType | enum | 读写方式 | - |
└─enumerate | boolean | 是否枚举 | - |
└─defaultValue | string | 默认值 | - |
└─unit | string | 单位 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─remark | string | 描述 | - |
└─origin | enum | 属性来源 | - |
└─ctrlStatus | boolean | 是否属于控制状态 | - |
└─createTime | string | 创建时间 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─funcApis | array | 物模型功能接口 | - |
└─id | int64 | No comments found. | - |
└─type | enum | 接口类型 | - |
└─direct | string | 协议指令 | - |
└─code | string | 功能代码 | - |
└─debug | boolean | 显示到调试 | - |
└─protocol | boolean | 是否为协议接口 | - |
└─productId | int64 | 所属产品 | - |
└─name | string | 接口名称 | - |
└─status | string | 接口状态 | - |
└─remark | string | 接口说明 | - |
└─asStatus | boolean | 作为状态位(用于点位控制协议) | - |
└─createTime | string | 创建时间 | - |
└─funcType | enum | 功能类型 | - |
└─productCode | string | No comments found. | - |
└─triggerMode | enum | 事件触发方式 | - |
└─directParams | object | 指令参数 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─_children | map | No comments found. | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─upConfig | array | 上行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─downConfig | array | 下行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─eventApis | array | 物模型事件接口 | - |
└─id | int64 | No comments found. | - |
└─type | enum | 接口类型 | - |
└─direct | string | 协议指令 | - |
└─code | string | 功能代码 | - |
└─debug | boolean | 显示到调试 | - |
└─protocol | boolean | 是否为协议接口 | - |
└─productId | int64 | 所属产品 | - |
└─name | string | 接口名称 | - |
└─status | string | 接口状态 | - |
└─remark | string | 接口说明 | - |
└─asStatus | boolean | 作为状态位(用于点位控制协议) | - |
└─createTime | string | 创建时间 | - |
└─funcType | enum | 功能类型 | - |
└─productCode | string | No comments found. | - |
└─triggerMode | enum | 事件触发方式 | - |
└─directParams | object | 指令参数 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─_children | map | No comments found. | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─upConfig | array | 上行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─downConfig | array | 下行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─apiCodeDebugMap | map | 接口调试参数 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─disabled | boolean | 是否禁用 | - |
└─checked | boolean | 是否默认选中 | - |
└─children | array | 子项 | - |
└─extra | object | 额外扩展信息 | - |
└─selectable | boolean | 可选中 | - |
└─checkable | boolean | 复选框是否能被选中 | - |
└─config | map | 配置项 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"device": {
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"deviceType": "Direct",
"gatewayId": 0,
"gatewayName": "",
"connectType": "Client",
"productCode": "",
"productName": "",
"protocolCode": "",
"productTypeName": "",
"deviceGroupName": "",
"alias": "PLC",
"protocolCodes": [
""
],
"protocol": "TCP"
},
"product": {
"id": 0,
"logo": "",
"status": "enabled",
"code": "",
"deviceType": "Direct",
"productTypeId": 0,
"typeName": "",
"name": "",
"parentId": 0,
"gatewayId": 0,
"protocolId": 0,
"config": {
"map": {
"mapKey": {}
}
},
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"gatewayType": "Direct",
"gatewayName": "",
"protocolName": "",
"protocolCode": "",
"connectType": "Client",
"deviceCount": 0,
"ctrlMode": "COMMON",
"gatewayStatus": "stop",
"transportProtocol": "TCP",
"attrs": [
{
"id": 0,
"productId": 0,
"field": "",
"name": "",
"dataType": "",
"realType": "",
"attrType": "R",
"enumerate": true,
"defaultValue": "",
"unit": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"remark": "",
"origin": "Protocol",
"ctrlStatus": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
],
"funcApis": [
{
"id": 0,
"type": "func",
"direct": "",
"code": "",
"debug": true,
"protocol": true,
"productId": 0,
"name": "",
"status": "",
"remark": "",
"asStatus": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"funcType": "R",
"productCode": "",
"triggerMode": "active",
"directParams": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
},
"_children": {
"mapKey": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true
}
}
},
"upConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
],
"downConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
]
}
],
"eventApis": [
{
"id": 0,
"type": "func",
"direct": "",
"code": "",
"debug": true,
"protocol": true,
"productId": 0,
"name": "",
"status": "",
"remark": "",
"asStatus": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"funcType": "R",
"productCode": "",
"triggerMode": "active",
"directParams": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
},
"_children": {
"mapKey": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true
}
}
},
"upConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
],
"downConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
]
}
]
},
"apiCodeDebugMap": {
"mapKey": {}
}
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/debug/detail?deviceId=0&=76r8lv'2.8. 设备分组管理
2.8.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
children | array | false | 此节点的子节点 | ||
pid | int64 | false | 父级 | ||
lon | string | false | 经度 | ||
lat | string | false | 纬度 | ||
name | string | false | 分组名称 | ||
path | string | false | 路径 | ||
remark | string | false | 备注 | ||
address | string | false | 分组地址 | ||
productIds | object | false | 产品id列表 | ||
└─list | array | false | No comments found. | ||
productNames | string | false | 产品名列表 | ||
createTime | string | false | 创建时间 | ||
groupProductId | int64 | false | 组产品id | ||
productId | int64 | false | 产品id | ||
parentName | string | false | 父级名称 | ||
deviceIds | array | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─children | array | 此节点的子节点 | - |
└─pid | int64 | 父级 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─name | string | 分组名称 | - |
└─path | string | 路径 | - |
└─remark | string | 备注 | - |
└─address | string | 分组地址 | - |
└─productIds | object | 产品id列表 | - |
└─list | array | No comments found. | - |
└─productNames | string | 产品名列表 | - |
└─createTime | string | 创建时间 | - |
└─groupProductId | int64 | 组产品id | - |
└─productId | int64 | 产品id | - |
└─parentName | string | 父级名称 | - |
└─deviceIds | array | No comments found. | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"lon": "",
"lat": "",
"name": "",
"path": "",
"remark": "",
"address": "",
"productIds": {
"list": [
{
"object": "any object"
}
]
},
"productNames": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"groupProductId": 0,
"productId": 0,
"parentName": "",
"deviceIds": [
0
]
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/deviceGroup/view?size=0¤t=0&id=0&pid=0&createTime=yyyy-MM-dd HH:mm:ss&groupProductId=0&productId=0&deviceIds=,&pages=0&orders[0].pid=0&orders[0].deviceIds=,&total=0&orders[0].id=0&remark=&records[0].lon=&orders[0].path=&records[0].pid=0&records[0].deviceIds=,&orders[0].address=&records[0].lat=&orders[0].createTime=yyyy-MM-dd HH:mm:ss&productNames=&records[0].createTime=yyyy-MM-dd HH:mm:ss&records[0].name=&records[0].remark=&isSearchCount=true&orders[0].lon=&records[0].parentName=&optimizeCountSql=true&records[0].productId=0&orders[0].lat=&hitCount=true&lon=&records[0].address=&lat=&orders[0].groupProductId=0&orders[0].remark=&maxLimit=0&path=&address=&orders[0].parentName=&orders[0].name=&records[0].id=0&name=&parentName=&orders[0].productNames=&records[0].path=&countId=&records[0].groupProductId=0&orders[0].productId=0&records[0].productNames='2.8.2. 获取所有组列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取所有组列表
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─children | array | 此节点的子节点 | - |
└─pid | int64 | 父级 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─name | string | 分组名称 | - |
└─path | string | 路径 | - |
└─remark | string | 备注 | - |
└─address | string | 分组地址 | - |
└─productIds | object | 产品id列表 | - |
└─list | array | No comments found. | - |
└─productNames | string | 产品名列表 | - |
└─createTime | string | 创建时间 | - |
└─groupProductId | int64 | 组产品id | - |
└─productId | int64 | 产品id | - |
└─parentName | string | 父级名称 | - |
└─deviceIds | array | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"lon": "",
"lat": "",
"name": "",
"path": "",
"remark": "",
"address": "",
"productIds": {
"list": [
{
"object": "any object"
}
]
},
"productNames": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"groupProductId": 0,
"productId": 0,
"parentName": "",
"deviceIds": [
0
]
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/deviceGroup/list'2.8.3. 树结构分组列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 树结构分组列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. | ||
children | array | false | 此节点的子节点 | ||
pid | int64 | false | 父级 | ||
lon | string | false | 经度 | ||
lat | string | false | 纬度 | ||
name | string | false | 分组名称 | ||
path | string | false | 路径 | ||
remark | string | false | 备注 | ||
address | string | false | 分组地址 | ||
productIds | object | false | 产品id列表 | ||
└─list | array | false | No comments found. | ||
productNames | string | false | 产品名列表 | ||
createTime | string | false | 创建时间 | ||
groupProductId | int64 | false | 组产品id | ||
productId | int64 | false | 产品id | ||
parentName | string | false | 父级名称 | ||
deviceIds | array | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─children | array | 此节点的子节点 | - |
└─pid | int64 | 父级 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─name | string | 分组名称 | - |
└─path | string | 路径 | - |
└─remark | string | 备注 | - |
└─address | string | 分组地址 | - |
└─productIds | object | 产品id列表 | - |
└─list | array | No comments found. | - |
└─productNames | string | 产品名列表 | - |
└─createTime | string | 创建时间 | - |
└─groupProductId | int64 | 组产品id | - |
└─productId | int64 | 产品id | - |
└─parentName | string | 父级名称 | - |
└─deviceIds | array | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"lon": "",
"lat": "",
"name": "",
"path": "",
"remark": "",
"address": "",
"productIds": {
"list": [
{
"object": "any object"
}
]
},
"productNames": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"groupProductId": 0,
"productId": 0,
"parentName": "",
"deviceIds": [
0
]
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/deviceGroup/tree?id=0&pid=0&createTime=yyyy-MM-dd HH:mm:ss&groupProductId=0&productId=0&deviceIds=,&name=&productNames=&parentName=&remark=&path=&lon=&address=&lat='2.8.4. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | 记录id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─children | array | 此节点的子节点 | - |
└─pid | int64 | 父级 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─name | string | 分组名称 | - |
└─path | string | 路径 | - |
└─remark | string | 备注 | - |
└─address | string | 分组地址 | - |
└─productIds | object | 产品id列表 | - |
└─list | array | No comments found. | - |
└─productNames | string | 产品名列表 | - |
└─createTime | string | 创建时间 | - |
└─groupProductId | int64 | 组产品id | - |
└─productId | int64 | 产品id | - |
└─parentName | string | 父级名称 | - |
└─deviceIds | array | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"lon": "",
"lat": "",
"name": "",
"path": "",
"remark": "",
"address": "",
"productIds": {
"list": [
{
"object": "any object"
}
]
},
"productNames": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"groupProductId": 0,
"productId": 0,
"parentName": "",
"deviceIds": [
0
]
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/deviceGroup/edit?id=0&=uhrhw1'2.8.5. 新增或者更新记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
children | array | false | 此节点的子节点 |
pid | int64 | false | 父级 |
lon | string | false | 经度 |
lat | string | false | 纬度 |
name | string | false | 分组名称 |
path | string | false | 路径 |
remark | string | false | 备注 |
address | string | false | 分组地址 |
productIds | object | false | 产品id列表 |
└─list | array | false | No comments found. |
productNames | string | false | 产品名列表 |
createTime | string | false | 创建时间 |
groupProductId | int64 | false | 组产品id |
productId | int64 | false | 产品id |
parentName | string | false | 父级名称 |
deviceIds | array | false | No comments found. |
Request-body:
{
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"lon": "",
"lat": "",
"name": "",
"path": "",
"remark": "",
"address": "",
"productIds": {
"list": [
{
"object": "any object"
}
]
},
"productNames": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"groupProductId": 0,
"productId": 0,
"parentName": "",
"deviceIds": [
0
]
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/deviceGroup/saveOrUpdate' --data '{
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"lon": "",
"lat": "",
"name": "",
"path": "",
"remark": "",
"address": "",
"productIds": {
"list": [
{
"object": "any object"
}
]
},
"productNames": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"groupProductId": 0,
"productId": 0,
"parentName": "",
"deviceIds": [
0
]
}'2.8.6. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/deviceGroup/del' --data '[
0
]'2.8.7. 获取物模型接口列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取物模型接口列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
deviceGroupId | int64 | false | 设备组id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─disabled | boolean | 是否禁用 | - |
└─checked | boolean | 是否默认选中 | - |
└─children | array | 子项 | - |
└─extra | object | 额外扩展信息 | - |
└─selectable | boolean | 可选中 | - |
└─checkable | boolean | 复选框是否能被选中 | - |
└─config | map | 配置项 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"label": "",
"value": {
"object": "any object"
},
"disabled": true,
"checked": true,
"children": [
{
"$ref": ".."
}
],
"extra": {
"object": "any object"
},
"selectable": true,
"checkable": true,
"config": {
"mapKey": {}
}
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/deviceGroup/listModelApi?deviceGroupId=0&=bqkr4n'2.9. 电子地图模块
2.9.1. 获取设备列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取设备列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
productId | int64 | false | 产品id | ||
deviceGroupId | int64 | false | 设备组id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─uid | string | 设备uid | - |
└─productId | int64 | 所属产品 | - |
└─deviceGroupId | int64 | 所属组 | - |
└─deviceSn | string | 设备编号 | - |
└─name | string | 设备名称 | - |
└─status | enum | 设备状态 | - |
└─address | string | 设备所在地址 | - |
└─lon | string | 设备经度 | - |
└─lat | string | 设备纬度 | - |
└─logo | string | 设备图片 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"uid": "",
"productId": 0,
"deviceGroupId": 0,
"deviceSn": "",
"name": "",
"status": "online",
"address": "",
"lon": "",
"lat": "",
"logo": ""
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/emap/devices?productId=0&deviceGroupId=0&=okyuwo'2.9.2. 获取设备详情
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取设备详情
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
uid | string | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─ctrlApi | object | 控制api | - |
└─id | int64 | No comments found. | - |
└─type | enum | 接口类型 | - |
└─direct | string | 协议指令 | - |
└─code | string | 功能代码 | - |
└─debug | boolean | 显示到调试 | - |
└─protocol | boolean | 是否为协议接口 | - |
└─productId | int64 | 所属产品 | - |
└─name | string | 接口名称 | - |
└─status | string | 接口状态 | - |
└─remark | string | 接口说明 | - |
└─asStatus | boolean | 作为状态位(用于点位控制协议) | - |
└─createTime | string | 创建时间 | - |
└─funcType | enum | 功能类型 | - |
└─productCode | string | No comments found. | - |
└─triggerMode | enum | 事件触发方式 | - |
└─directParams | object | 指令参数 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─_children | map | No comments found. | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─upConfig | array | 上行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─downConfig | array | 下行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─ctrlAttrValue | object | 控制api的属性值 | - |
└─ctrlAttrs | array | 控制api的属性选项 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─disabled | boolean | 是否禁用 | - |
└─checked | boolean | 是否默认选中 | - |
└─children | array | 子项 | - |
└─extra | object | 额外扩展信息 | - |
└─selectable | boolean | 可选中 | - |
└─checkable | boolean | 复选框是否能被选中 | - |
└─config | map | 配置项 | - |
└─any object | object | any object. | - |
└─funcApis | array | 物模型功能接口 | - |
└─id | int64 | No comments found. | - |
└─type | enum | 接口类型 | - |
└─direct | string | 协议指令 | - |
└─code | string | 功能代码 | - |
└─debug | boolean | 显示到调试 | - |
└─protocol | boolean | 是否为协议接口 | - |
└─productId | int64 | 所属产品 | - |
└─name | string | 接口名称 | - |
└─status | string | 接口状态 | - |
└─remark | string | 接口说明 | - |
└─asStatus | boolean | 作为状态位(用于点位控制协议) | - |
└─createTime | string | 创建时间 | - |
└─funcType | enum | 功能类型 | - |
└─productCode | string | No comments found. | - |
└─triggerMode | enum | 事件触发方式 | - |
└─directParams | object | 指令参数 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─_children | map | No comments found. | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─upConfig | array | 上行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─downConfig | array | 下行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─eventApis | array | 物模型事件接口 | - |
└─id | int64 | No comments found. | - |
└─type | enum | 接口类型 | - |
└─direct | string | 协议指令 | - |
└─code | string | 功能代码 | - |
└─debug | boolean | 显示到调试 | - |
└─protocol | boolean | 是否为协议接口 | - |
└─productId | int64 | 所属产品 | - |
└─name | string | 接口名称 | - |
└─status | string | 接口状态 | - |
└─remark | string | 接口说明 | - |
└─asStatus | boolean | 作为状态位(用于点位控制协议) | - |
└─createTime | string | 创建时间 | - |
└─funcType | enum | 功能类型 | - |
└─productCode | string | No comments found. | - |
└─triggerMode | enum | 事件触发方式 | - |
└─directParams | object | 指令参数 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─_children | map | No comments found. | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─upConfig | array | 上行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─downConfig | array | 下行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─attrs | array | 模型属性列表 | - |
└─field | string | 属性代码 | - |
└─name | string | 属性名称 | - |
└─unit | string | 单位 | - |
└─value | object | 实时值 | - |
└─collectTime | string | 采集时间 | - |
└─status | enum | No comments found. | - |
└─warns | array | 告警记录 | - |
└─grade | string | 告警等级 | - |
└─content | string | 告警内容 | - |
└─warnTime | string | No comments found. | - |
└─apiCodeDebugMap | map | 接口调试参数 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─disabled | boolean | 是否禁用 | - |
└─checked | boolean | 是否默认选中 | - |
└─children | array | 子项 | - |
└─extra | object | 额外扩展信息 | - |
└─selectable | boolean | 可选中 | - |
└─checkable | boolean | 复选框是否能被选中 | - |
└─config | map | 配置项 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"ctrlApi": {
"id": 0,
"type": "func",
"direct": "",
"code": "",
"debug": true,
"protocol": true,
"productId": 0,
"name": "",
"status": "",
"remark": "",
"asStatus": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"funcType": "R",
"productCode": "",
"triggerMode": "active",
"directParams": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
},
"_children": {
"mapKey": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true
}
}
},
"upConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
],
"downConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
]
},
"ctrlAttrValue": {
"object": "any object"
},
"ctrlAttrs": [
{
"label": "",
"value": {
"object": "any object"
},
"disabled": true,
"checked": true,
"children": [
{
"$ref": ".."
}
],
"extra": {
"object": "any object"
},
"selectable": true,
"checkable": true,
"config": {
"mapKey": {}
}
}
],
"funcApis": [
{
"id": 0,
"type": "func",
"direct": "",
"code": "",
"debug": true,
"protocol": true,
"productId": 0,
"name": "",
"status": "",
"remark": "",
"asStatus": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"funcType": "R",
"productCode": "",
"triggerMode": "active",
"directParams": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
},
"_children": {
"mapKey": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true
}
}
},
"upConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
],
"downConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
]
}
],
"eventApis": [
{
"id": 0,
"type": "func",
"direct": "",
"code": "",
"debug": true,
"protocol": true,
"productId": 0,
"name": "",
"status": "",
"remark": "",
"asStatus": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"funcType": "R",
"productCode": "",
"triggerMode": "active",
"directParams": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
},
"_children": {
"mapKey": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true
}
}
},
"upConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
],
"downConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
]
}
],
"attrs": [
{
"field": "",
"name": "",
"unit": "",
"value": {
"object": "any object"
},
"collectTime": "yyyy-MM-dd HH:mm:ss",
"status": "Success"
}
],
"warns": [
{
"grade": "",
"content": "",
"warnTime": "yyyy-MM-dd HH:mm:ss"
}
],
"apiCodeDebugMap": {
"mapKey": {}
}
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/emap/detail?=juw9o5'2.10. 事件源管理
2.10.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
type | enum | false | 事件类型 | ||
cron | string | false | 采集周期 | ||
name | string | false | 事件名称 | ||
status | enum | false | 场景状态 | ||
hasPassive | boolean | false | 有没有被动事件 | ||
createTime | string | false | 创建时间 | ||
reason | string | false | 启用失败原因 | ||
productId | int64 | false | 产品 | ||
deviceGroupId | int64 | false | 设备组id | ||
productIds | object | false | 操作的产品 | ||
└─list | array | false | No comments found. | ||
deviceGroupIds | object | false | 设备组 | ||
└─list | array | false | No comments found. | ||
modelApiIds | array | false | 模型接口列表 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─type | enum | 事件类型 | - |
└─cron | string | 采集周期 | - |
└─name | string | 事件名称 | - |
└─status | enum | 场景状态 | - |
└─hasPassive | boolean | 有没有被动事件 | - |
└─createTime | string | 创建时间 | - |
└─reason | string | 启用失败原因 | - |
└─productId | int64 | 产品 | - |
└─deviceGroupId | int64 | 设备组id | - |
└─productIds | object | 操作的产品 | - |
└─list | array | No comments found. | - |
└─deviceGroupIds | object | 设备组 | - |
└─list | array | No comments found. | - |
└─modelApiIds | array | 模型接口列表 | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"type": "event",
"cron": "",
"name": "",
"status": "enabled",
"hasPassive": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"reason": "",
"productId": 0,
"deviceGroupId": 0,
"productIds": {
"list": [
{
"object": "any object"
}
]
},
"deviceGroupIds": {
"list": [
{
"object": "any object"
}
]
},
"modelApiIds": [
""
]
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/eventSource/view?size=0¤t=0&id=0&type=event&status=enabled&hasPassive=true&createTime=yyyy-MM-dd HH:mm:ss&productId=0&deviceGroupId=0&modelApiIds=,&records[0].name=&records[0].productId=0&records[0].reason=&cron=&records[0].cron=&orders[0].hasPassive=true&orders[0].deviceGroupId=0&orders[0].modelApiIds=,&records[0].status=enabled&records[0].hasPassive=true&optimizeCountSql=true&records[0].id=0&reason=&orders[0].id=0&orders[0].productId=0&orders[0].status=enabled&orders[0].name=&total=0&countId=&orders[0].cron=&records[0].type=event&records[0].deviceGroupId=0&orders[0].createTime=yyyy-MM-dd HH:mm:ss&isSearchCount=true&maxLimit=0&records[0].createTime=yyyy-MM-dd HH:mm:ss&hitCount=true&name=&records[0].modelApiIds=,&orders[0].type=event&pages=0&orders[0].reason='2.10.2. 事件源列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 事件源列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. | ||
type | enum | false | 事件类型 | ||
cron | string | false | 采集周期 | ||
name | string | false | 事件名称 | ||
status | enum | false | 场景状态 | ||
hasPassive | boolean | false | 有没有被动事件 | ||
createTime | string | false | 创建时间 | ||
reason | string | false | 启用失败原因 | ||
productId | int64 | false | 产品 | ||
deviceGroupId | int64 | false | 设备组id | ||
productIds | object | false | 操作的产品 | ||
└─list | array | false | No comments found. | ||
deviceGroupIds | object | false | 设备组 | ||
└─list | array | false | No comments found. | ||
modelApiIds | array | false | 模型接口列表 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─type | enum | 事件类型 | - |
└─cron | string | 采集周期 | - |
└─name | string | 事件名称 | - |
└─status | enum | 场景状态 | - |
└─hasPassive | boolean | 有没有被动事件 | - |
└─createTime | string | 创建时间 | - |
└─reason | string | 启用失败原因 | - |
└─productId | int64 | 产品 | - |
└─deviceGroupId | int64 | 设备组id | - |
└─productIds | object | 操作的产品 | - |
└─list | array | No comments found. | - |
└─deviceGroupIds | object | 设备组 | - |
└─list | array | No comments found. | - |
└─modelApiIds | array | 模型接口列表 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"type": "event",
"cron": "",
"name": "",
"status": "enabled",
"hasPassive": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"reason": "",
"productId": 0,
"deviceGroupId": 0,
"productIds": {
"list": [
{
"object": "any object"
}
]
},
"deviceGroupIds": {
"list": [
{
"object": "any object"
}
]
},
"modelApiIds": [
""
]
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/eventSource/list?id=0&type=event&status=enabled&hasPassive=true&createTime=yyyy-MM-dd HH:mm:ss&productId=0&deviceGroupId=0&modelApiIds=,&name=&cron=&reason='2.10.3. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | 记录id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─type | enum | 事件类型 | - |
└─cron | string | 采集周期 | - |
└─name | string | 事件名称 | - |
└─status | enum | 场景状态 | - |
└─hasPassive | boolean | 有没有被动事件 | - |
└─createTime | string | 创建时间 | - |
└─reason | string | 启用失败原因 | - |
└─productId | int64 | 产品 | - |
└─deviceGroupId | int64 | 设备组id | - |
└─productIds | object | 操作的产品 | - |
└─list | array | No comments found. | - |
└─deviceGroupIds | object | 设备组 | - |
└─list | array | No comments found. | - |
└─modelApiIds | array | 模型接口列表 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"type": "event",
"cron": "",
"name": "",
"status": "enabled",
"hasPassive": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"reason": "",
"productId": 0,
"deviceGroupId": 0,
"productIds": {
"list": [
{
"object": "any object"
}
]
},
"deviceGroupIds": {
"list": [
{
"object": "any object"
}
]
},
"modelApiIds": [
""
]
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/eventSource/edit?id=0&=hm4kw2'2.10.4. 新增或者更新记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
type | enum | false | 事件类型 |
cron | string | false | 采集周期 |
name | string | false | 事件名称 |
status | enum | false | 场景状态 |
hasPassive | boolean | false | 有没有被动事件 |
createTime | string | false | 创建时间 |
reason | string | false | 启用失败原因 |
productId | int64 | false | 产品 |
deviceGroupId | int64 | false | 设备组id |
productIds | object | false | 操作的产品 |
└─list | array | false | No comments found. |
deviceGroupIds | object | false | 设备组 |
└─list | array | false | No comments found. |
modelApiIds | array | false | 模型接口列表 |
Request-body:
{
"id": 0,
"type": "event",
"cron": "",
"name": "",
"status": "enabled",
"hasPassive": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"reason": "",
"productId": 0,
"deviceGroupId": 0,
"productIds": {
"list": [
{
"object": "any object"
}
]
},
"deviceGroupIds": {
"list": [
{
"object": "any object"
}
]
},
"modelApiIds": [
""
]
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/eventSource/saveOrUpdate' --data '{
"id": 0,
"type": "event",
"cron": "",
"name": "",
"status": "enabled",
"hasPassive": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"reason": "",
"productId": 0,
"deviceGroupId": 0,
"productIds": {
"list": [
{
"object": "any object"
}
]
},
"deviceGroupIds": {
"list": [
{
"object": "any object"
}
]
},
"modelApiIds": [
""
]
}'2.10.5. 配置物模型接口
Type: POST
Author: iteaj
Content-Type: application/json
Description: 配置物模型接口
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
type | enum | false | 事件类型 |
cron | string | false | 采集周期 |
name | string | false | 事件名称 |
status | enum | false | 场景状态 |
hasPassive | boolean | false | 有没有被动事件 |
createTime | string | false | 创建时间 |
reason | string | false | 启用失败原因 |
productId | int64 | false | 产品 |
deviceGroupId | int64 | false | 设备组id |
productIds | object | false | 操作的产品 |
└─list | array | false | No comments found. |
deviceGroupIds | object | false | 设备组 |
└─list | array | false | No comments found. |
modelApiIds | array | false | 模型接口列表 |
Request-body:
{
"id": 0,
"type": "event",
"cron": "",
"name": "",
"status": "enabled",
"hasPassive": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"reason": "",
"productId": 0,
"deviceGroupId": 0,
"productIds": {
"list": [
{
"object": "any object"
}
]
},
"deviceGroupIds": {
"list": [
{
"object": "any object"
}
]
},
"modelApiIds": [
""
]
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/eventSource/config' --data '{
"id": 0,
"type": "event",
"cron": "",
"name": "",
"status": "enabled",
"hasPassive": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"reason": "",
"productId": 0,
"deviceGroupId": 0,
"productIds": {
"list": [
{
"object": "any object"
}
]
},
"deviceGroupIds": {
"list": [
{
"object": "any object"
}
]
},
"modelApiIds": [
""
]
}'2.10.6. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/eventSource/del' --data '[
0
]'2.10.7. 事件源类型
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 事件源类型
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─disabled | boolean | 是否禁用 | - |
└─checked | boolean | 是否默认选中 | - |
└─children | array | 子项 | - |
└─extra | object | 额外扩展信息 | - |
└─selectable | boolean | 可选中 | - |
└─checkable | boolean | 复选框是否能被选中 | - |
└─config | map | 配置项 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"label": "",
"value": {
"object": "any object"
},
"disabled": true,
"checked": true,
"children": [
{
"$ref": ".."
}
],
"extra": {
"object": "any object"
},
"selectable": true,
"checkable": true,
"config": {
"mapKey": {}
}
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/eventSource/types'2.10.8. 获取设备组列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取设备组列表
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─disabled | boolean | 是否禁用 | - |
└─checked | boolean | 是否默认选中 | - |
└─children | array | 子项 | - |
└─extra | object | 额外扩展信息 | - |
└─selectable | boolean | 可选中 | - |
└─checkable | boolean | 复选框是否能被选中 | - |
└─config | map | 配置项 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"label": "",
"value": {
"object": "any object"
},
"disabled": true,
"checked": true,
"children": [
{
"$ref": ".."
}
],
"extra": {
"object": "any object"
},
"selectable": true,
"checkable": true,
"config": {
"mapKey": {}
}
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/eventSource/deviceGroups'2.10.9. 切换事件源状态
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 切换事件源状态
Path-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
status | enum | true | enabled(启用) |
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/eventSource/switch/{status}?id=0&=bm9cco'2.11. 事件源详情管理
2.11.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
eventSourceId | int64 | false | 所属事件源 | ||
modelApiId | int64 | false | 物模型接口 | ||
createTime | string | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─eventSourceId | int64 | 所属事件源 | - |
└─modelApiId | int64 | 物模型接口 | - |
└─createTime | string | No comments found. | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"eventSourceId": 0,
"modelApiId": 0,
"createTime": "yyyy-MM-dd HH:mm:ss"
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/eventSourceDetail/view?size=0¤t=0&id=0&eventSourceId=0&modelApiId=0&createTime=yyyy-MM-dd HH:mm:ss&countId=&orders[0].createTime=yyyy-MM-dd HH:mm:ss&isSearchCount=true&records[0].modelApiId=0&optimizeCountSql=true&orders[0].modelApiId=0&total=0&orders[0].id=0&pages=0&orders[0].eventSourceId=0&records[0].createTime=yyyy-MM-dd HH:mm:ss&records[0].id=0&records[0].eventSourceId=0&maxLimit=0&hitCount=true'2.11.2. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | 记录id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─eventSourceId | int64 | 所属事件源 | - |
└─modelApiId | int64 | 物模型接口 | - |
└─createTime | string | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"eventSourceId": 0,
"modelApiId": 0,
"createTime": "yyyy-MM-dd HH:mm:ss"
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/eventSourceDetail/edit?id=0&=wmtald'2.11.3. 新增或者更新记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
eventSourceId | int64 | false | 所属事件源 |
modelApiId | int64 | false | 物模型接口 |
createTime | string | false | No comments found. |
Request-body:
{
"id": 0,
"eventSourceId": 0,
"modelApiId": 0,
"createTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/eventSourceDetail/saveOrUpdate' --data '{
"id": 0,
"eventSourceId": 0,
"modelApiId": 0,
"createTime": "yyyy-MM-dd HH:mm:ss"
}'2.11.4. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/eventSourceDetail/del' --data '[
0
]'2.12. 协议网关管理
2.12.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
name | string | true | 网关名称 | ||
type | enum | false | 设备类型(设备直连、边缘网关) | ||
host | string | false | 主机地址 | ||
port | int32 | false | 网关端口 | ||
username | string | false | 用户名 | ||
useSsl | boolean | false | 是否启用ssl | ||
password | string | false | 密码 | ||
reason | string | false | 失败原因 | ||
protocolId | int64 | true | 绑定协议 | ||
status | enum | false | 网关状态 | ||
config | object | false | 网关配置 | ||
└─map | map | false | No comments found. | ||
└─any object | object | false | any object. | ||
remark | string | false | 备注 | ||
createTime | string | false | 创建时间 | ||
updateTime | string | false | 更新时间 | ||
connectType | enum | false | 网关连接类型 | ||
protocolType | enum | true | 传输协议 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─name | string | 网关名称 | - |
└─type | enum | 设备类型(设备直连、边缘网关) | - |
└─host | string | 主机地址 | - |
└─port | int32 | 网关端口 | - |
└─username | string | 用户名 | - |
└─useSsl | boolean | 是否启用ssl | - |
└─password | string | 密码 | - |
└─reason | string | 失败原因 | - |
└─protocolId | int64 | 绑定协议 | - |
└─status | enum | 网关状态 | - |
└─config | object | 网关配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─remark | string | 备注 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
└─connectType | enum | 网关连接类型 | - |
└─protocolType | enum | 传输协议 | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"name": "",
"type": "Direct",
"host": "",
"port": 0,
"username": "",
"useSsl": true,
"password": "",
"reason": "",
"protocolId": 0,
"status": "stop",
"config": {
"map": {
"mapKey": {}
}
},
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"connectType": "Client",
"protocolType": "TCP"
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/gateway/view?size=0¤t=0&id=0&type=Direct&port=0&useSsl=true&protocolId=0&status=stop&createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&connectType=Client&protocolType=TCP&name=&records[0].name=&records[0].remark=&records[0].createTime=yyyy-MM-dd HH:mm:ss&orders[0].useSsl=true&orders[0].updateTime=yyyy-MM-dd HH:mm:ss&orders[0].password=&username=&records[0].password=&orders[0].reason=&records[0].type=Direct&total=0&records[0].host=&orders[0].protocolId=0&records[0].status=stop&orders[0].connectType=Client&orders[0].remark=&records[0].updateTime=yyyy-MM-dd HH:mm:ss&orders[0].name=&orders[0].host=&isSearchCount=true&orders[0].id=0&orders[0].createTime=yyyy-MM-dd HH:mm:ss&host=&orders[0].type=Direct&records[0].protocolType=TCP&records[0].port=0&orders[0].status=stop&countId=&hitCount=true&orders[0].port=0&records[0].username=&orders[0].protocolType=TCP&records[0].protocolId=0&records[0].connectType=Client&maxLimit=0&remark=&optimizeCountSql=true&records[0].id=0&pages=0&records[0].reason=&orders[0].username=&reason=&records[0].useSsl=true&password='2.12.2. 获取网关列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取网关列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. | ||
name | string | true | 网关名称 | ||
type | enum | false | 设备类型(设备直连、边缘网关) | ||
host | string | false | 主机地址 | ||
port | int32 | false | 网关端口 | ||
username | string | false | 用户名 | ||
useSsl | boolean | false | 是否启用ssl | ||
password | string | false | 密码 | ||
reason | string | false | 失败原因 | ||
protocolId | int64 | true | 绑定协议 | ||
status | enum | false | 网关状态 | ||
config | object | false | 网关配置 | ||
└─map | map | false | No comments found. | ||
└─any object | object | false | any object. | ||
remark | string | false | 备注 | ||
createTime | string | false | 创建时间 | ||
updateTime | string | false | 更新时间 | ||
connectType | enum | false | 网关连接类型 | ||
protocolType | enum | true | 传输协议 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─name | string | 网关名称 | - |
└─type | enum | 设备类型(设备直连、边缘网关) | - |
└─host | string | 主机地址 | - |
└─port | int32 | 网关端口 | - |
└─username | string | 用户名 | - |
└─useSsl | boolean | 是否启用ssl | - |
└─password | string | 密码 | - |
└─reason | string | 失败原因 | - |
└─protocolId | int64 | 绑定协议 | - |
└─status | enum | 网关状态 | - |
└─config | object | 网关配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─remark | string | 备注 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
└─connectType | enum | 网关连接类型 | - |
└─protocolType | enum | 传输协议 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"name": "",
"type": "Direct",
"host": "",
"port": 0,
"username": "",
"useSsl": true,
"password": "",
"reason": "",
"protocolId": 0,
"status": "stop",
"config": {
"map": {
"mapKey": {}
}
},
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"connectType": "Client",
"protocolType": "TCP"
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/gateway/list?id=0&type=Direct&port=0&useSsl=true&protocolId=0&status=stop&createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&connectType=Client&protocolType=TCP&password=&remark=&reason=&name=&host=&username='2.12.3. 协议列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 协议列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
type | enum | false | Direct(设备直连) | ||
protocolType | enum | false | TCP(TCP协议, NetworkConfigImpl.TcpNetworkConfig.tcpMetas, false) | ||
connectionType | enum | false | Client(客户端) |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─disabled | boolean | 是否禁用 | - |
└─checked | boolean | 是否默认选中 | - |
└─children | array | 子项 | - |
└─extra | object | 额外扩展信息 | - |
└─selectable | boolean | 可选中 | - |
└─checkable | boolean | 复选框是否能被选中 | - |
└─config | map | 配置项 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"label": "",
"value": {
"object": "any object"
},
"disabled": true,
"checked": true,
"children": [
{
"$ref": ".."
}
],
"extra": {
"object": "any object"
},
"selectable": true,
"checkable": true,
"config": {
"mapKey": {}
}
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/gateway/protocols?type=Direct&protocolType=TCP&connectionType=Client'2.12.4. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | 记录id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─name | string | 网关名称 | - |
└─type | enum | 设备类型(设备直连、边缘网关) | - |
└─host | string | 主机地址 | - |
└─port | int32 | 网关端口 | - |
└─username | string | 用户名 | - |
└─useSsl | boolean | 是否启用ssl | - |
└─password | string | 密码 | - |
└─reason | string | 失败原因 | - |
└─protocolId | int64 | 绑定协议 | - |
└─status | enum | 网关状态 | - |
└─config | object | 网关配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─remark | string | 备注 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
└─connectType | enum | 网关连接类型 | - |
└─protocolType | enum | 传输协议 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"name": "",
"type": "Direct",
"host": "",
"port": 0,
"username": "",
"useSsl": true,
"password": "",
"reason": "",
"protocolId": 0,
"status": "stop",
"config": {
"map": {
"mapKey": {}
}
},
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"connectType": "Client",
"protocolType": "TCP"
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/gateway/edit?id=0&=fszwl6'2.12.5. 新增或者更新记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
name | string | true | 网关名称 |
type | enum | false | 设备类型(设备直连、边缘网关) |
host | string | false | 主机地址 |
port | int32 | false | 网关端口 |
username | string | false | 用户名 |
useSsl | boolean | false | 是否启用ssl |
password | string | false | 密码 |
reason | string | false | 失败原因 |
protocolId | int64 | true | 绑定协议 |
status | enum | false | 网关状态 |
config | object | false | 网关配置 |
└─map | map | false | No comments found. |
└─any object | object | false | any object. |
remark | string | false | 备注 |
createTime | string | false | 创建时间 |
updateTime | string | false | 更新时间 |
connectType | enum | false | 网关连接类型 |
protocolType | enum | true | 传输协议 |
Request-body:
{
"id": 0,
"name": "",
"type": "Direct",
"host": "",
"port": 0,
"username": "",
"useSsl": true,
"password": "",
"reason": "",
"protocolId": 0,
"status": "stop",
"config": {
"map": {
"mapKey": {}
}
},
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"connectType": "Client",
"protocolType": "TCP"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/gateway/saveOrUpdate' --data '{
"id": 0,
"name": "",
"type": "Direct",
"host": "",
"port": 0,
"username": "",
"useSsl": true,
"password": "",
"reason": "",
"protocolId": 0,
"status": "stop",
"config": {
"map": {
"mapKey": {}
}
},
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"connectType": "Client",
"protocolType": "TCP"
}'2.12.6. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/gateway/del' --data '[
0
]'2.12.7. 传输协议列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 传输协议列表
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─disabled | boolean | 是否禁用 | - |
└─checked | boolean | 是否默认选中 | - |
└─children | array | 子项 | - |
└─extra | object | 额外扩展信息 | - |
└─selectable | boolean | 可选中 | - |
└─checkable | boolean | 复选框是否能被选中 | - |
└─config | map | 配置项 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"label": "",
"value": {
"object": "any object"
},
"disabled": true,
"checked": true,
"children": [
{
"$ref": ".."
}
],
"extra": {
"object": "any object"
},
"selectable": true,
"checkable": true,
"config": {
"mapKey": {}
}
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/gateway/transportProtocol'2.12.8. 切换网关状态
Type: POST
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 切换网关状态
Path-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | true | 网关id | ||
status | enum | true | stop, start |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -i 'http://127.0.0.1:8085/api/iot/gateway/switch/{id}/{status}'2.13. dtu设备管理
2.13.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
ip | string | false | 设备ip | ||
pid | int64 | false | 父网关设备 | ||
uid | string | false | 设备uid | ||
name | string | true | 设备名称 | ||
port | int32 | false | 设备端口 | ||
extend | string | false | 拓展字段 | ||
productId | int64 | true | 所属产品 | ||
deviceGroupId | int64 | false | 所属组 | ||
productTypeId | int64 | false | 设备类型 | ||
lon | string | false | 经度 | ||
lat | string | false | 纬度 | ||
address | string | false | 地址 | ||
account | string | false | 设备账号 | ||
password | string | false | 设备密码 | ||
status | enum | false | 设备状态 | ||
deviceSn | string | true | 设备编号 | ||
parentDeviceSn | string | false | 父设备编号 | ||
config | object | false | 设备配置 | ||
└─map | map | false | No comments found. | ||
└─any object | object | false | any object. | ||
switchTime | string | false | 状态切换时间 | ||
createTime | string | false | 新增时间 | ||
updateTime | string | false | 更新时间 | ||
deviceType | enum | false | 设备类型 | ||
gatewayId | int64 | false | 所属网关 | ||
gatewayName | string | false | 网关名称 | ||
connectType | enum | false | 连接类型 | ||
productCode | string | false | 产品代码 | ||
productName | string | false | 产品名称 | ||
protocolCode | string | false | 协议码 | ||
productTypeName | string | false | 产品类型名称 | ||
deviceGroupName | string | false | 所属分组 | ||
alias | enum | false | 设备别名 | ||
protocolCodes | array | false | 协议码列表 | ||
protocol | enum | false | 协议类型 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─ip | string | 设备ip | - |
└─pid | int64 | 父网关设备 | - |
└─uid | string | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─extend | string | 拓展字段 | - |
└─productId | int64 | 所属产品 | - |
└─deviceGroupId | int64 | 所属组 | - |
└─productTypeId | int64 | 设备类型 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─parentDeviceSn | string | 父设备编号 | - |
└─config | object | 设备配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | 新增时间 | - |
└─updateTime | string | 更新时间 | - |
└─deviceType | enum | 设备类型 | - |
└─gatewayId | int64 | 所属网关 | - |
└─gatewayName | string | 网关名称 | - |
└─connectType | enum | 连接类型 | - |
└─productCode | string | 产品代码 | - |
└─productName | string | 产品名称 | - |
└─protocolCode | string | 协议码 | - |
└─productTypeName | string | 产品类型名称 | - |
└─deviceGroupName | string | 所属分组 | - |
└─alias | enum | 设备别名 | - |
└─protocolCodes | array | 协议码列表 | - |
└─protocol | enum | 协议类型 | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"deviceType": "Direct",
"gatewayId": 0,
"gatewayName": "",
"connectType": "Client",
"productCode": "",
"productName": "",
"protocolCode": "",
"productTypeName": "",
"deviceGroupName": "",
"alias": "PLC",
"protocolCodes": [
""
],
"protocol": "TCP"
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/dtu/view?size=0¤t=0&id=0&pid=0&port=0&productId=0&deviceGroupId=0&productTypeId=0&status=online&switchTime=yyyy-MM-dd HH:mm:ss&createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&deviceType=Direct&gatewayId=0&connectType=Client&alias=PLC&protocolCodes=,&protocol=TCP&ip=&records[0].id=0&records[0].deviceGroupId=0&records[0].password=&orders[0].lat=&orders[0].updateTime=yyyy-MM-dd HH:mm:ss&optimizeCountSql=true&account=&protocolCode=&orders[0].productTypeId=0&name=&parentDeviceSn=&records[0].extend=&total=0&orders[0].createTime=yyyy-MM-dd HH:mm:ss&deviceGroupName=&records[0].parentDeviceSn=&orders[0].ip=&orders[0].status=online&orders[0].id=0&records[0].updateTime=yyyy-MM-dd HH:mm:ss&orders[0].productId=0&records[0].deviceSn=&countId=&orders[0].parentDeviceSn=&productCode=&records[0].name=&records[0].uid=&orders[0].pid=0&isSearchCount=true&orders[0].password=&records[0].pid=0&records[0].port=0&uid=&password=&records[0].ip=&records[0].lat=&orders[0].extend=&lon=&hitCount=true&orders[0].port=0&records[0].status=online&orders[0].uid=&records[0].productId=0&lat=&pages=0&orders[0].switchTime=yyyy-MM-dd HH:mm:ss&records[0].switchTime=yyyy-MM-dd HH:mm:ss&orders[0].name=&orders[0].lon=&records[0].productTypeId=0&orders[0].deviceGroupId=0&orders[0].address=&deviceSn=&records[0].createTime=yyyy-MM-dd HH:mm:ss&productName=&maxLimit=0&gatewayName=&records[0].address=&records[0].account=&orders[0].deviceSn=&records[0].lon=&orders[0].account=&address=&productTypeName=&extend='2.13.2. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | 记录id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─ip | string | 设备ip | - |
└─pid | int64 | 父网关设备 | - |
└─uid | string | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─extend | string | 拓展字段 | - |
└─productId | int64 | 所属产品 | - |
└─deviceGroupId | int64 | 所属组 | - |
└─productTypeId | int64 | 设备类型 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─parentDeviceSn | string | 父设备编号 | - |
└─config | object | 设备配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | 新增时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/dtu/edit?id=0&=fis2sp'2.13.3. 新增或者修改记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增或者修改记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
ip | string | false | 设备ip |
pid | int64 | false | 父网关设备 |
uid | string | false | 设备uid |
name | string | true | 设备名称 |
port | int32 | false | 设备端口 |
extend | string | false | 拓展字段 |
productId | int64 | true | 所属产品 |
deviceGroupId | int64 | false | 所属组 |
productTypeId | int64 | false | 设备类型 |
lon | string | false | 经度 |
lat | string | false | 纬度 |
address | string | false | 地址 |
account | string | false | 设备账号 |
password | string | false | 设备密码 |
status | enum | false | 设备状态 |
deviceSn | string | true | 设备编号 |
parentDeviceSn | string | false | 父设备编号 |
config | object | false | 设备配置 |
└─map | map | false | No comments found. |
└─any object | object | false | any object. |
switchTime | string | false | 状态切换时间 |
createTime | string | false | 新增时间 |
updateTime | string | false | 更新时间 |
Request-body:
{
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/dtu/saveOrUpdate' --data '{
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}'2.13.4. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/dtu/del' --data '[
0
]'2.13.5. 获取Dtu产品列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取Dtu产品列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
deviceType | enum | false | Direct(设备直连) |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─logo | string | 图标 | - |
└─status | enum | 产品状态 | - |
└─code | string | 产品代码 | - |
└─deviceType | enum | 设备类型 | - |
└─productTypeId | int64 | 产品类型 | - |
└─typeName | string | 类型名称 | - |
└─name | string | 产品名称 | - |
└─parentId | int64 | 父产品id | - |
└─gatewayId | int64 | 绑定的网关 | - |
└─protocolId | int64 | 绑定的协议 | - |
└─config | object | 产品配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─remark | string | 产品说明 | - |
└─createTime | string | 创建时间 | - |
└─gatewayType | enum | 网关类型 | - |
└─gatewayName | string | 网关名称 | - |
└─protocolName | string | 协议名称 | - |
└─protocolCode | string | 协议代码 | - |
└─connectType | enum | 网关连接类型 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"logo": "",
"status": "enabled",
"code": "",
"deviceType": "Direct",
"productTypeId": 0,
"typeName": "",
"name": "",
"parentId": 0,
"gatewayId": 0,
"protocolId": 0,
"config": {
"map": {
"mapKey": {}
}
},
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"gatewayType": "Direct",
"gatewayName": "",
"protocolName": "",
"protocolCode": "",
"connectType": "Client"
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/dtu/products?deviceType=Direct'2.14. modbus设备管理
2.14.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
ip | string | false | 设备ip | ||
pid | int64 | false | 父网关设备 | ||
uid | string | false | 设备uid | ||
name | string | true | 设备名称 | ||
port | int32 | false | 设备端口 | ||
extend | string | false | 拓展字段 | ||
productId | int64 | true | 所属产品 | ||
deviceGroupId | int64 | false | 所属组 | ||
productTypeId | int64 | false | 设备类型 | ||
lon | string | false | 经度 | ||
lat | string | false | 纬度 | ||
address | string | false | 地址 | ||
account | string | false | 设备账号 | ||
password | string | false | 设备密码 | ||
status | enum | false | 设备状态 | ||
deviceSn | string | true | 设备编号 | ||
parentDeviceSn | string | false | 父设备编号 | ||
config | object | false | 设备配置 | ||
└─map | map | false | No comments found. | ||
└─any object | object | false | any object. | ||
switchTime | string | false | 状态切换时间 | ||
createTime | string | false | 新增时间 | ||
updateTime | string | false | 更新时间 | ||
deviceType | enum | false | 设备类型 | ||
gatewayId | int64 | false | 所属网关 | ||
gatewayName | string | false | 网关名称 | ||
connectType | enum | false | 连接类型 | ||
productCode | string | false | 产品代码 | ||
productName | string | false | 产品名称 | ||
protocolCode | string | false | 协议码 | ||
productTypeName | string | false | 产品类型名称 | ||
deviceGroupName | string | false | 所属分组 | ||
alias | enum | false | 设备别名 | ||
protocolCodes | array | false | 协议码列表 | ||
protocol | enum | false | 协议类型 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─ip | string | 设备ip | - |
└─pid | int64 | 父网关设备 | - |
└─uid | string | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─extend | string | 拓展字段 | - |
└─productId | int64 | 所属产品 | - |
└─deviceGroupId | int64 | 所属组 | - |
└─productTypeId | int64 | 设备类型 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─parentDeviceSn | string | 父设备编号 | - |
└─config | object | 设备配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | 新增时间 | - |
└─updateTime | string | 更新时间 | - |
└─deviceType | enum | 设备类型 | - |
└─gatewayId | int64 | 所属网关 | - |
└─gatewayName | string | 网关名称 | - |
└─connectType | enum | 连接类型 | - |
└─productCode | string | 产品代码 | - |
└─productName | string | 产品名称 | - |
└─protocolCode | string | 协议码 | - |
└─productTypeName | string | 产品类型名称 | - |
└─deviceGroupName | string | 所属分组 | - |
└─alias | enum | 设备别名 | - |
└─protocolCodes | array | 协议码列表 | - |
└─protocol | enum | 协议类型 | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"deviceType": "Direct",
"gatewayId": 0,
"gatewayName": "",
"connectType": "Client",
"productCode": "",
"productName": "",
"protocolCode": "",
"productTypeName": "",
"deviceGroupName": "",
"alias": "PLC",
"protocolCodes": [
""
],
"protocol": "TCP"
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/modbus/view?size=0¤t=0&id=0&pid=0&port=0&productId=0&deviceGroupId=0&productTypeId=0&status=online&switchTime=yyyy-MM-dd HH:mm:ss&createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&deviceType=Direct&gatewayId=0&connectType=Client&alias=PLC&protocolCodes=,&protocol=TCP&records[0].port=0&orders[0].productId=0&orders[0].deviceSn=&records[0].productId=0&records[0].address=&orders[0].updateTime=yyyy-MM-dd HH:mm:ss&orders[0].port=0&orders[0].pid=0&records[0].id=0&records[0].status=online&gatewayName=&lat=&records[0].productTypeId=0&records[0].lat=&records[0].uid=&records[0].password=&orders[0].uid=&parentDeviceSn=&records[0].createTime=yyyy-MM-dd HH:mm:ss&orders[0].extend=&extend=&ip=&records[0].account=&address=&productCode=&records[0].ip=&records[0].lon=&productName=&protocolCode=&orders[0].password=&orders[0].account=&uid=&productTypeName=&orders[0].switchTime=yyyy-MM-dd HH:mm:ss&orders[0].id=0&orders[0].address=&orders[0].ip=&pages=0&records[0].parentDeviceSn=&orders[0].deviceGroupId=0&deviceSn=&orders[0].productTypeId=0&records[0].extend=&account=&records[0].deviceGroupId=0&orders[0].lon=&records[0].deviceSn=&lon=&records[0].pid=0&hitCount=true&total=0&orders[0].name=&isSearchCount=true&records[0].name=&password=&records[0].switchTime=yyyy-MM-dd HH:mm:ss&optimizeCountSql=true&orders[0].createTime=yyyy-MM-dd HH:mm:ss&orders[0].parentDeviceSn=&maxLimit=0&deviceGroupName=&countId=&name=&records[0].updateTime=yyyy-MM-dd HH:mm:ss&orders[0].lat=&orders[0].status=online'2.14.2. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | 记录id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─ip | string | 设备ip | - |
└─pid | int64 | 父网关设备 | - |
└─uid | string | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─extend | string | 拓展字段 | - |
└─productId | int64 | 所属产品 | - |
└─deviceGroupId | int64 | 所属组 | - |
└─productTypeId | int64 | 设备类型 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─parentDeviceSn | string | 父设备编号 | - |
└─config | object | 设备配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | 新增时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/modbus/edit?id=0&=ox7yih'2.14.3. 新增或者修改记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增或者修改记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
ip | string | false | 设备ip |
pid | int64 | false | 父网关设备 |
uid | string | false | 设备uid |
name | string | true | 设备名称 |
port | int32 | false | 设备端口 |
extend | string | false | 拓展字段 |
productId | int64 | true | 所属产品 |
deviceGroupId | int64 | false | 所属组 |
productTypeId | int64 | false | 设备类型 |
lon | string | false | 经度 |
lat | string | false | 纬度 |
address | string | false | 地址 |
account | string | false | 设备账号 |
password | string | false | 设备密码 |
status | enum | false | 设备状态 |
deviceSn | string | true | 设备编号 |
parentDeviceSn | string | false | 父设备编号 |
config | object | false | 设备配置 |
└─map | map | false | No comments found. |
└─any object | object | false | any object. |
switchTime | string | false | 状态切换时间 |
createTime | string | false | 新增时间 |
updateTime | string | false | 更新时间 |
Request-body:
{
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/modbus/saveOrUpdate' --data '{
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}'2.14.4. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/modbus/del' --data '[
0
]'2.14.5. 获取Modbus产品列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取Modbus产品列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
deviceType | enum | false | Direct(设备直连) |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─logo | string | 图标 | - |
└─status | enum | 产品状态 | - |
└─code | string | 产品代码 | - |
└─deviceType | enum | 设备类型 | - |
└─productTypeId | int64 | 产品类型 | - |
└─typeName | string | 类型名称 | - |
└─name | string | 产品名称 | - |
└─parentId | int64 | 父产品id | - |
└─gatewayId | int64 | 绑定的网关 | - |
└─protocolId | int64 | 绑定的协议 | - |
└─config | object | 产品配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─remark | string | 产品说明 | - |
└─createTime | string | 创建时间 | - |
└─gatewayType | enum | 网关类型 | - |
└─gatewayName | string | 网关名称 | - |
└─protocolName | string | 协议名称 | - |
└─protocolCode | string | 协议代码 | - |
└─connectType | enum | 网关连接类型 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"logo": "",
"status": "enabled",
"code": "",
"deviceType": "Direct",
"productTypeId": 0,
"typeName": "",
"name": "",
"parentId": 0,
"gatewayId": 0,
"protocolId": 0,
"config": {
"map": {
"mapKey": {}
}
},
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"gatewayType": "Direct",
"gatewayName": "",
"protocolName": "",
"protocolCode": "",
"connectType": "Client"
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/modbus/products?deviceType=Direct'2.15. mqtt管理
2.15.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
ip | string | false | 设备ip | ||
pid | int64 | false | 父网关设备 | ||
uid | string | false | 设备uid | ||
name | string | true | 设备名称 | ||
port | int32 | false | 设备端口 | ||
extend | string | false | 拓展字段 | ||
productId | int64 | true | 所属产品 | ||
deviceGroupId | int64 | false | 所属组 | ||
productTypeId | int64 | false | 设备类型 | ||
lon | string | false | 经度 | ||
lat | string | false | 纬度 | ||
address | string | false | 地址 | ||
account | string | false | 设备账号 | ||
password | string | false | 设备密码 | ||
status | enum | false | 设备状态 | ||
deviceSn | string | true | 设备编号 | ||
parentDeviceSn | string | false | 父设备编号 | ||
config | object | false | 设备配置 | ||
└─map | map | false | No comments found. | ||
└─any object | object | false | any object. | ||
switchTime | string | false | 状态切换时间 | ||
createTime | string | false | 新增时间 | ||
updateTime | string | false | 更新时间 | ||
deviceType | enum | false | 设备类型 | ||
gatewayId | int64 | false | 所属网关 | ||
gatewayName | string | false | 网关名称 | ||
connectType | enum | false | 连接类型 | ||
productCode | string | false | 产品代码 | ||
productName | string | false | 产品名称 | ||
protocolCode | string | false | 协议码 | ||
productTypeName | string | false | 产品类型名称 | ||
deviceGroupName | string | false | 所属分组 | ||
alias | enum | false | 设备别名 | ||
protocolCodes | array | false | 协议码列表 | ||
protocol | enum | false | 协议类型 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─ip | string | 设备ip | - |
└─pid | int64 | 父网关设备 | - |
└─uid | string | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─extend | string | 拓展字段 | - |
└─productId | int64 | 所属产品 | - |
└─deviceGroupId | int64 | 所属组 | - |
└─productTypeId | int64 | 设备类型 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─parentDeviceSn | string | 父设备编号 | - |
└─config | object | 设备配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | 新增时间 | - |
└─updateTime | string | 更新时间 | - |
└─deviceType | enum | 设备类型 | - |
└─gatewayId | int64 | 所属网关 | - |
└─gatewayName | string | 网关名称 | - |
└─connectType | enum | 连接类型 | - |
└─productCode | string | 产品代码 | - |
└─productName | string | 产品名称 | - |
└─protocolCode | string | 协议码 | - |
└─productTypeName | string | 产品类型名称 | - |
└─deviceGroupName | string | 所属分组 | - |
└─alias | enum | 设备别名 | - |
└─protocolCodes | array | 协议码列表 | - |
└─protocol | enum | 协议类型 | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"deviceType": "Direct",
"gatewayId": 0,
"gatewayName": "",
"connectType": "Client",
"productCode": "",
"productName": "",
"protocolCode": "",
"productTypeName": "",
"deviceGroupName": "",
"alias": "PLC",
"protocolCodes": [
""
],
"protocol": "TCP"
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/mqtt/view?size=0¤t=0&id=0&pid=0&port=0&productId=0&deviceGroupId=0&productTypeId=0&status=online&switchTime=yyyy-MM-dd HH:mm:ss&createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&deviceType=Direct&gatewayId=0&connectType=Client&alias=PLC&protocolCodes=,&protocol=TCP&lon=&deviceSn=&records[0].switchTime=yyyy-MM-dd HH:mm:ss&records[0].uid=&extend=&records[0].deviceGroupId=0&orders[0].productId=0&name=&optimizeCountSql=true&records[0].lat=&account=&maxLimit=0&productTypeName=&deviceGroupName=&orders[0].updateTime=yyyy-MM-dd HH:mm:ss&productName=&orders[0].extend=&records[0].name=&orders[0].lat=&protocolCode=&orders[0].uid=&orders[0].address=&records[0].parentDeviceSn=&orders[0].ip=&orders[0].name=&orders[0].status=online&records[0].account=&countId=&orders[0].createTime=yyyy-MM-dd HH:mm:ss&parentDeviceSn=&gatewayName=&records[0].updateTime=yyyy-MM-dd HH:mm:ss&records[0].deviceSn=&orders[0].lon=&orders[0].productTypeId=0&records[0].extend=&orders[0].deviceSn=&pages=0&records[0].ip=&records[0].lon=&orders[0].password=&ip=&lat=&isSearchCount=true&records[0].password=&records[0].status=online&orders[0].switchTime=yyyy-MM-dd HH:mm:ss&records[0].productId=0&orders[0].parentDeviceSn=&orders[0].port=0&records[0].address=&hitCount=true&password=&address=&orders[0].account=&orders[0].id=0&productCode=&records[0].productTypeId=0&records[0].createTime=yyyy-MM-dd HH:mm:ss&records[0].id=0&total=0&orders[0].pid=0&uid=&orders[0].deviceGroupId=0&records[0].port=0&records[0].pid=0'2.15.2. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | 记录id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─ip | string | 设备ip | - |
└─pid | int64 | 父网关设备 | - |
└─uid | string | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─extend | string | 拓展字段 | - |
└─productId | int64 | 所属产品 | - |
└─deviceGroupId | int64 | 所属组 | - |
└─productTypeId | int64 | 设备类型 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─parentDeviceSn | string | 父设备编号 | - |
└─config | object | 设备配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | 新增时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/mqtt/edit?id=0&=zmr67c'2.15.3. 新增或者修改记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增或者修改记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
ip | string | false | 设备ip |
pid | int64 | false | 父网关设备 |
uid | string | false | 设备uid |
name | string | true | 设备名称 |
port | int32 | false | 设备端口 |
extend | string | false | 拓展字段 |
productId | int64 | true | 所属产品 |
deviceGroupId | int64 | false | 所属组 |
productTypeId | int64 | false | 设备类型 |
lon | string | false | 经度 |
lat | string | false | 纬度 |
address | string | false | 地址 |
account | string | false | 设备账号 |
password | string | false | 设备密码 |
status | enum | false | 设备状态 |
deviceSn | string | true | 设备编号 |
parentDeviceSn | string | false | 父设备编号 |
config | object | false | 设备配置 |
└─map | map | false | No comments found. |
└─any object | object | false | any object. |
switchTime | string | false | 状态切换时间 |
createTime | string | false | 新增时间 |
updateTime | string | false | 更新时间 |
Request-body:
{
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/mqtt/saveOrUpdate' --data '{
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}'2.15.4. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/mqtt/del' --data '[
0
]'2.15.5. 获取Mqtt产品列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取Mqtt产品列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
deviceType | enum | false | Direct(设备直连) |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─logo | string | 图标 | - |
└─status | enum | 产品状态 | - |
└─code | string | 产品代码 | - |
└─deviceType | enum | 设备类型 | - |
└─productTypeId | int64 | 产品类型 | - |
└─typeName | string | 类型名称 | - |
└─name | string | 产品名称 | - |
└─parentId | int64 | 父产品id | - |
└─gatewayId | int64 | 绑定的网关 | - |
└─protocolId | int64 | 绑定的协议 | - |
└─config | object | 产品配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─remark | string | 产品说明 | - |
└─createTime | string | 创建时间 | - |
└─gatewayType | enum | 网关类型 | - |
└─gatewayName | string | 网关名称 | - |
└─protocolName | string | 协议名称 | - |
└─protocolCode | string | 协议代码 | - |
└─connectType | enum | 网关连接类型 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"logo": "",
"status": "enabled",
"code": "",
"deviceType": "Direct",
"productTypeId": 0,
"typeName": "",
"name": "",
"parentId": 0,
"gatewayId": 0,
"protocolId": 0,
"config": {
"map": {
"mapKey": {}
}
},
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"gatewayType": "Direct",
"gatewayName": "",
"protocolName": "",
"protocolCode": "",
"connectType": "Client"
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/mqtt/products?deviceType=Direct'2.16. plc设备管理
2.16.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
ip | string | false | 设备ip | ||
pid | int64 | false | 父网关设备 | ||
uid | string | false | 设备uid | ||
name | string | true | 设备名称 | ||
port | int32 | false | 设备端口 | ||
extend | string | false | 拓展字段 | ||
productId | int64 | true | 所属产品 | ||
deviceGroupId | int64 | false | 所属组 | ||
productTypeId | int64 | false | 设备类型 | ||
lon | string | false | 经度 | ||
lat | string | false | 纬度 | ||
address | string | false | 地址 | ||
account | string | false | 设备账号 | ||
password | string | false | 设备密码 | ||
status | enum | false | 设备状态 | ||
deviceSn | string | true | 设备编号 | ||
parentDeviceSn | string | false | 父设备编号 | ||
config | object | false | 设备配置 | ||
└─map | map | false | No comments found. | ||
└─any object | object | false | any object. | ||
switchTime | string | false | 状态切换时间 | ||
createTime | string | false | 新增时间 | ||
updateTime | string | false | 更新时间 | ||
deviceType | enum | false | 设备类型 | ||
gatewayId | int64 | false | 所属网关 | ||
gatewayName | string | false | 网关名称 | ||
connectType | enum | false | 连接类型 | ||
productCode | string | false | 产品代码 | ||
productName | string | false | 产品名称 | ||
protocolCode | string | false | 协议码 | ||
productTypeName | string | false | 产品类型名称 | ||
deviceGroupName | string | false | 所属分组 | ||
alias | enum | false | 设备别名 | ||
protocolCodes | array | false | 协议码列表 | ||
protocol | enum | false | 协议类型 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─ip | string | 设备ip | - |
└─pid | int64 | 父网关设备 | - |
└─uid | string | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─extend | string | 拓展字段 | - |
└─productId | int64 | 所属产品 | - |
└─deviceGroupId | int64 | 所属组 | - |
└─productTypeId | int64 | 设备类型 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─parentDeviceSn | string | 父设备编号 | - |
└─config | object | 设备配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | 新增时间 | - |
└─updateTime | string | 更新时间 | - |
└─deviceType | enum | 设备类型 | - |
└─gatewayId | int64 | 所属网关 | - |
└─gatewayName | string | 网关名称 | - |
└─connectType | enum | 连接类型 | - |
└─productCode | string | 产品代码 | - |
└─productName | string | 产品名称 | - |
└─protocolCode | string | 协议码 | - |
└─productTypeName | string | 产品类型名称 | - |
└─deviceGroupName | string | 所属分组 | - |
└─alias | enum | 设备别名 | - |
└─protocolCodes | array | 协议码列表 | - |
└─protocol | enum | 协议类型 | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"deviceType": "Direct",
"gatewayId": 0,
"gatewayName": "",
"connectType": "Client",
"productCode": "",
"productName": "",
"protocolCode": "",
"productTypeName": "",
"deviceGroupName": "",
"alias": "PLC",
"protocolCodes": [
""
],
"protocol": "TCP"
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/plc/view?size=0¤t=0&id=0&pid=0&port=0&productId=0&deviceGroupId=0&productTypeId=0&status=online&switchTime=yyyy-MM-dd HH:mm:ss&createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&deviceType=Direct&gatewayId=0&connectType=Client&alias=PLC&protocolCodes=,&protocol=TCP&records[0].lat=&records[0].address=&orders[0].deviceGroupId=0&optimizeCountSql=true&orders[0].extend=&records[0].id=0&records[0].deviceSn=&records[0].productTypeId=0&hitCount=true&parentDeviceSn=&records[0].ip=&pages=0&records[0].lon=&records[0].status=online&records[0].productId=0&total=0&orders[0].uid=&orders[0].createTime=yyyy-MM-dd HH:mm:ss&orders[0].updateTime=yyyy-MM-dd HH:mm:ss&records[0].extend=&orders[0].address=&records[0].account=&orders[0].port=0&maxLimit=0&records[0].updateTime=yyyy-MM-dd HH:mm:ss&ip=&records[0].password=&records[0].pid=0&extend=&orders[0].productTypeId=0&records[0].port=0&orders[0].productId=0&lat=&records[0].switchTime=yyyy-MM-dd HH:mm:ss&records[0].uid=&password=&uid=&name=&orders[0].deviceSn=&countId=&deviceSn=&address=&account=&gatewayName=&productName=&orders[0].lon=&orders[0].account=&orders[0].id=0&records[0].deviceGroupId=0&records[0].parentDeviceSn=&orders[0].status=online&orders[0].pid=0&isSearchCount=true&deviceGroupName=&orders[0].ip=&orders[0].switchTime=yyyy-MM-dd HH:mm:ss&productTypeName=&orders[0].name=&lon=&records[0].name=&orders[0].password=&productCode=&orders[0].lat=&protocolCode=&records[0].createTime=yyyy-MM-dd HH:mm:ss&orders[0].parentDeviceSn='2.16.2. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | 记录id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─ip | string | 设备ip | - |
└─pid | int64 | 父网关设备 | - |
└─uid | string | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─extend | string | 拓展字段 | - |
└─productId | int64 | 所属产品 | - |
└─deviceGroupId | int64 | 所属组 | - |
└─productTypeId | int64 | 设备类型 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─parentDeviceSn | string | 父设备编号 | - |
└─config | object | 设备配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | 新增时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/plc/edit?id=0&=lzc1y4'2.16.3. 新增或者修改记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增或者修改记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
ip | string | false | 设备ip |
pid | int64 | false | 父网关设备 |
uid | string | false | 设备uid |
name | string | true | 设备名称 |
port | int32 | false | 设备端口 |
extend | string | false | 拓展字段 |
productId | int64 | true | 所属产品 |
deviceGroupId | int64 | false | 所属组 |
productTypeId | int64 | false | 设备类型 |
lon | string | false | 经度 |
lat | string | false | 纬度 |
address | string | false | 地址 |
account | string | false | 设备账号 |
password | string | false | 设备密码 |
status | enum | false | 设备状态 |
deviceSn | string | true | 设备编号 |
parentDeviceSn | string | false | 父设备编号 |
config | object | false | 设备配置 |
└─map | map | false | No comments found. |
└─any object | object | false | any object. |
switchTime | string | false | 状态切换时间 |
createTime | string | false | 新增时间 |
updateTime | string | false | 更新时间 |
Request-body:
{
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/plc/saveOrUpdate' --data '{
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}'2.16.4. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/plc/del' --data '[
0
]'2.16.5. 获取Dtu产品列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取Dtu产品列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
deviceType | enum | false | Direct(设备直连) |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─logo | string | 图标 | - |
└─status | enum | 产品状态 | - |
└─code | string | 产品代码 | - |
└─deviceType | enum | 设备类型 | - |
└─productTypeId | int64 | 产品类型 | - |
└─typeName | string | 类型名称 | - |
└─name | string | 产品名称 | - |
└─parentId | int64 | 父产品id | - |
└─gatewayId | int64 | 绑定的网关 | - |
└─protocolId | int64 | 绑定的协议 | - |
└─config | object | 产品配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─remark | string | 产品说明 | - |
└─createTime | string | 创建时间 | - |
└─gatewayType | enum | 网关类型 | - |
└─gatewayName | string | 网关名称 | - |
└─protocolName | string | 协议名称 | - |
└─protocolCode | string | 协议代码 | - |
└─connectType | enum | 网关连接类型 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"logo": "",
"status": "enabled",
"code": "",
"deviceType": "Direct",
"productTypeId": 0,
"typeName": "",
"name": "",
"parentId": 0,
"gatewayId": 0,
"protocolId": 0,
"config": {
"map": {
"mapKey": {}
}
},
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"gatewayType": "Direct",
"gatewayName": "",
"protocolName": "",
"protocolCode": "",
"connectType": "Client"
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/plc/products?deviceType=Direct'2.17. 串口设备管理
2.17.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
name | string | false | 设备名称 | ||
com | string | false | 串口 | ||
baudRate | int32 | false | 波特率 | ||
dataBits | int32 | false | 数据位 | ||
parity | int32 | false | 校验位 | ||
stopBits | int32 | false | 停止位 | ||
status | enum | false | 状态 | ||
createTime | string | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─name | string | 设备名称 | - |
└─com | string | 串口 | - |
└─baudRate | int32 | 波特率 | - |
└─dataBits | int32 | 数据位 | - |
└─parity | int32 | 校验位 | - |
└─stopBits | int32 | 停止位 | - |
└─status | enum | 状态 | - |
└─createTime | string | No comments found. | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"name": "",
"com": "",
"baudRate": 0,
"dataBits": 0,
"parity": 0,
"stopBits": 0,
"status": "open",
"createTime": "yyyy-MM-dd HH:mm:ss"
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/serial/view?size=0¤t=0&id=0&baudRate=0&dataBits=0&parity=0&stopBits=0&status=open&createTime=yyyy-MM-dd HH:mm:ss&records[0].dataBits=0&records[0].id=0&com=&hitCount=true&records[0].name=&orders[0].dataBits=0&records[0].createTime=yyyy-MM-dd HH:mm:ss&records[0].parity=0&maxLimit=0&name=&records[0].stopBits=0&optimizeCountSql=true&records[0].status=open&orders[0].createTime=yyyy-MM-dd HH:mm:ss&orders[0].parity=0&orders[0].id=0&orders[0].com=&total=0&orders[0].status=open&pages=0&records[0].com=&records[0].baudRate=0&orders[0].name=&orders[0].stopBits=0&isSearchCount=true&orders[0].baudRate=0&countId='2.17.2. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. | ||
name | string | false | 设备名称 | ||
com | string | false | 串口 | ||
baudRate | int32 | false | 波特率 | ||
dataBits | int32 | false | 数据位 | ||
parity | int32 | false | 校验位 | ||
stopBits | int32 | false | 停止位 | ||
status | enum | false | 状态 | ||
createTime | string | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─name | string | 设备名称 | - |
└─com | string | 串口 | - |
└─baudRate | int32 | 波特率 | - |
└─dataBits | int32 | 数据位 | - |
└─parity | int32 | 校验位 | - |
└─stopBits | int32 | 停止位 | - |
└─status | enum | 状态 | - |
└─createTime | string | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"name": "",
"com": "",
"baudRate": 0,
"dataBits": 0,
"parity": 0,
"stopBits": 0,
"status": "open",
"createTime": "yyyy-MM-dd HH:mm:ss"
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/serial/list?id=0&baudRate=0&dataBits=0&parity=0&stopBits=0&status=open&createTime=yyyy-MM-dd HH:mm:ss&name=&com='2.17.3. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | 记录id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─name | string | 设备名称 | - |
└─com | string | 串口 | - |
└─baudRate | int32 | 波特率 | - |
└─dataBits | int32 | 数据位 | - |
└─parity | int32 | 校验位 | - |
└─stopBits | int32 | 停止位 | - |
└─status | enum | 状态 | - |
└─createTime | string | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"name": "",
"com": "",
"baudRate": 0,
"dataBits": 0,
"parity": 0,
"stopBits": 0,
"status": "open",
"createTime": "yyyy-MM-dd HH:mm:ss"
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/serial/edit?id=0&=a55fs1'2.17.4. 获取记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
com | string | false | 串口 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─name | string | 设备名称 | - |
└─com | string | 串口 | - |
└─baudRate | int32 | 波特率 | - |
└─dataBits | int32 | 数据位 | - |
└─parity | int32 | 校验位 | - |
└─stopBits | int32 | 停止位 | - |
└─status | enum | 状态 | - |
└─createTime | string | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"name": "",
"com": "",
"baudRate": 0,
"dataBits": 0,
"parity": 0,
"stopBits": 0,
"status": "open",
"createTime": "yyyy-MM-dd HH:mm:ss"
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/serial/getByCom?=2kwked'2.17.5. 新增或者更新记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
name | string | false | 设备名称 |
com | string | false | 串口 |
baudRate | int32 | false | 波特率 |
dataBits | int32 | false | 数据位 |
parity | int32 | false | 校验位 |
stopBits | int32 | false | 停止位 |
status | enum | false | 状态 |
createTime | string | false | No comments found. |
Request-body:
{
"id": 0,
"name": "",
"com": "",
"baudRate": 0,
"dataBits": 0,
"parity": 0,
"stopBits": 0,
"status": "open",
"createTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/serial/saveOrUpdate' --data '{
"id": 0,
"name": "",
"com": "",
"baudRate": 0,
"dataBits": 0,
"parity": 0,
"stopBits": 0,
"status": "open",
"createTime": "yyyy-MM-dd HH:mm:ss"
}'2.17.6. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/serial/del' --data '[
0
]'2.17.7. 可用的串口列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 可用的串口列表
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─label | string | No comments found. | - |
└─value | string | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"label": "",
"value": ""
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/serial/available'2.17.8.
Type: POST
Author: iteaj
Content-Type: application/json
Description:
Path-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
status | enum | true | open, close |
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
name | string | false | 设备名称 |
com | string | false | 串口 |
baudRate | int32 | false | 波特率 |
dataBits | int32 | false | 数据位 |
parity | int32 | false | 校验位 |
stopBits | int32 | false | 停止位 |
status | enum | false | 状态 |
createTime | string | false | No comments found. |
Request-body:
{
"id": 0,
"name": "",
"com": "",
"baudRate": 0,
"dataBits": 0,
"parity": 0,
"stopBits": 0,
"status": "open",
"createTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/serial/connect/{status}' --data '{
"id": 0,
"name": "",
"com": "",
"baudRate": 0,
"dataBits": 0,
"parity": 0,
"stopBits": 0,
"status": "open",
"createTime": "yyyy-MM-dd HH:mm:ss"
}'2.18. 系统功能统计
2.18.1. 各组件的产品统计
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 各组件的产品统计
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─deviceNum | int32 | 总设备数量 | - |
└─onlineNum | int32 | 在线设备数量 | - |
└─productNum | int32 | 总产品数量 | - |
└─enabledProductNum | int32 | 启用的产品数量 | - |
└─eventSourceNum | int32 | 事件源数量 | - |
└─runningEventSourceNum | int32 | 运行中的事件源 | - |
└─protocolNum | int32 | 协议数量 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"deviceNum": 0,
"onlineNum": 0,
"productNum": 0,
"enabledProductNum": 0,
"eventSourceNum": 0,
"runningEventSourceNum": 0,
"protocolNum": 0
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/index/numCount'2.18.2. 各个产品下面的设备数量统计
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 各个产品下面的设备数量统计
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─name | string | 名称 | - |
└─value | object | 值 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"name": "",
"value": {
"object": "any object"
}
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/index/productDeviceCount'2.18.3. 各个设备类型下面的设备数量统计
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 各个设备类型下面的设备数量统计
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─type | enum | 设备类型 | - |
└─online | int32 | 在线数量 | - |
└─total | int32 | 总设备数 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"type": "Direct",
"online": 0,
"total": 0
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/index/deviceTypeCount'2.18.4. 统计最近一个月采集的数据
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 统计最近一个月采集的数据
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─value | object | No comments found. | - |
└─field | string | No comments found. | - |
└─category | string | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"value": {},
"field": "",
"category": ""
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/index/countDataWithLastMonth'2.19. 物模型接口配置管理
2.19.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
sort | int32 | false | 排序 | ||
apiCode | string | false | 接口码 | ||
attrField | string | false | 物模型属性字段 | ||
attrName | string | false | 属性名称 | ||
dataType | string | true | 属性类型 | ||
productId | int64 | true | 所属产品 | ||
remark | string | false | 备注 | ||
value | string | false | 配置值 | ||
modelAttrId | int64 | false | 模型属性id | ||
fieldType | enum | false | 字段类型 | ||
protocolDataType | string | true | 协议属性类型 | ||
protocolAttrField | string | true | 协议属性字段 | ||
protocolAttrName | string | false | 协议属性名称 | ||
createTime | string | false | 创建时间 | ||
direction | enum | false | 接口方向 | ||
accuracy | int32 | false | 精度 | ||
funcType | enum | false | 属性读写类型 | ||
attrDefaultValue | string | false | 属性默认值 | ||
gain | int32 | false | 数据增益 | ||
resolver | string | false | 数据解析器 | ||
script | string | false | 自定义解析脚本 | ||
dicts | array | false | 属性字典列表 | ||
└─id | int64 | false | No comments found. | ||
└─path | string | false | 路径 | ||
└─dictName | string | true | 字典名称 | ||
└─dictValue | string | true | 字典值 | ||
└─dataType | string | false | 数据类型 | ||
└─attrField | string | false | 属性字段 | ||
└─accuracy | int32 | false | 精度 | ||
└─gain | int32 | false | 数据增益 | ||
└─resolver | string | false | 数据解析器 | ||
└─script | string | false | 自定义解析脚本 | ||
└─modelAttrId | int64 | true | 模型属性id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/modelApiConfig/view?size=0¤t=0&id=0&sort=0&productId=0&modelAttrId=0&fieldType=status&createTime=yyyy-MM-dd HH:mm:ss&direction=UP&accuracy=0&funcType=R&gain=0&orders[0].attrField=&orders[0].direction=UP&records[0].apiCode=&dicts[0].id=0&dicts[0].gain=0&total=0&records[0].dicts[0].path=&orders[0].dicts[0].attrField=&records[0].fieldType=status&records[0].dicts[0].modelAttrId=0&dicts[0].accuracy=0&orders[0].dicts[0].accuracy=0&orders[0].protocolAttrField=&orders[0].dicts[0].path=&orders[0].dicts[0].dataType=&records[0].attrDefaultValue=&orders[0].dicts[0].id=0&dicts[0].dictValue=&orders[0].dicts[0].gain=0&orders[0].apiCode=&orders[0].dicts[0].resolver=&orders[0].accuracy=0&records[0].dicts[0].gain=0&records[0].dicts[0].script=&orders[0].value=&script=&dicts[0].resolver=&value=&orders[0].dataType=&records[0].dicts[0].accuracy=0&dicts[0].modelAttrId=0&records[0].dicts[0].dictName=&dicts[0].path=&orders[0].productId=0&countId=&records[0].protocolAttrField=&records[0].dicts[0].attrField=&records[0].resolver=&orders[0].funcType=R&records[0].funcType=R&orders[0].attrDefaultValue=&protocolAttrName=&isSearchCount=true&records[0].id=0&records[0].dicts[0].dataType=&dicts[0].script=&records[0].remark=&records[0].dataType=&orders[0].attrName=&pages=0&records[0].gain=0&orders[0].dicts[0].script=&records[0].protocolDataType=&records[0].dicts[0].id=0&resolver=&records[0].modelAttrId=0&orders[0].sort=0&maxLimit=0&orders[0].dicts[0].dictValue=&records[0].productId=0&orders[0].modelAttrId=0&orders[0].dicts[0].dictName=&orders[0].dicts[0].modelAttrId=0&records[0].sort=0&records[0].direction=UP&protocolDataType=&orders[0].resolver=&dataType=&records[0].script=&orders[0].protocolAttrName=&records[0].createTime=yyyy-MM-dd HH:mm:ss&orders[0].fieldType=status&records[0].protocolAttrName=&apiCode=&records[0].value=&orders[0].script=&records[0].attrName=&orders[0].protocolDataType=&remark=&orders[0].gain=0&dicts[0].attrField=&records[0].dicts[0].dictValue=&attrDefaultValue=&records[0].attrField=&records[0].accuracy=0&records[0].dicts[0].resolver=&attrField=&attrName=&hitCount=true&orders[0].id=0&protocolAttrField=&dicts[0].dataType=&optimizeCountSql=true&orders[0].remark=&orders[0].createTime=yyyy-MM-dd HH:mm:ss&dicts[0].dictName='2.19.2. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | 记录id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/modelApiConfig/edit?id=0&=t84r3a'2.19.3. 新增或者更新记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
sort | int32 | false | 排序 |
apiCode | string | false | 接口码 |
attrField | string | false | 物模型属性字段 |
attrName | string | false | 属性名称 |
dataType | string | true | 属性类型 |
productId | int64 | true | 所属产品 |
remark | string | false | 备注 |
value | string | false | 配置值 |
modelAttrId | int64 | false | 模型属性id |
fieldType | enum | false | 字段类型 |
protocolDataType | string | true | 协议属性类型 |
protocolAttrField | string | true | 协议属性字段 |
protocolAttrName | string | false | 协议属性名称 |
createTime | string | false | 创建时间 |
direction | enum | false | 接口方向 |
accuracy | int32 | false | 精度 |
funcType | enum | false | 属性读写类型 |
attrDefaultValue | string | false | 属性默认值 |
gain | int32 | false | 数据增益 |
resolver | string | false | 数据解析器 |
script | string | false | 自定义解析脚本 |
dicts | array | false | 属性字典列表 |
└─id | int64 | false | No comments found. |
└─path | string | false | 路径 |
└─dictName | string | true | 字典名称 |
└─dictValue | string | true | 字典值 |
└─dataType | string | false | 数据类型 |
└─attrField | string | false | 属性字段 |
└─accuracy | int32 | false | 精度 |
└─gain | int32 | false | 数据增益 |
└─resolver | string | false | 数据解析器 |
└─script | string | false | 自定义解析脚本 |
└─modelAttrId | int64 | true | 模型属性id |
Request-body:
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/modelApiConfig/saveOrUpdate' --data '{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}'2.19.4. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/modelApiConfig/del' --data '[
0
]'2.20. 物模型接口管理
2.20.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
type | enum | true | 接口类型 | ||
direct | string | false | 协议指令 | ||
code | string | true | 功能代码 | ||
debug | boolean | false | 显示到调试 | ||
protocol | boolean | false | 是否为协议接口 | ||
productId | int64 | true | 所属产品 | ||
name | string | false | 接口名称 | ||
status | string | false | 接口状态 | ||
remark | string | false | 接口说明 | ||
asStatus | boolean | false | 作为状态位(用于点位控制协议) | ||
createTime | string | false | 创建时间 | ||
funcType | enum | false | 功能类型 | ||
productCode | string | false | No comments found. | ||
triggerMode | enum | false | 事件触发方式 | ||
directParams | object | false | 指令参数 | ||
└─array | boolean | false | No comments found. | ||
└─object | boolean | false | No comments found. | ||
└─containerNode | boolean | false | No comments found. | ||
└─valueNode | boolean | false | No comments found. | ||
└─missingNode | boolean | false | No comments found. | ||
└─_nodeFactory | object | false | No comments found. | ||
└─_cfgBigDecimalExact | boolean | false | No comments found. | ||
└─_children | map | false | No comments found. | ||
└─array | boolean | false | No comments found. | ||
└─object | boolean | false | No comments found. | ||
└─containerNode | boolean | false | No comments found. | ||
└─valueNode | boolean | false | No comments found. | ||
└─missingNode | boolean | false | No comments found. | ||
upConfig | array | false | 上行接口配置 | ||
└─id | int64 | false | No comments found. | ||
└─sort | int32 | false | 排序 | ||
└─apiCode | string | false | 接口码 | ||
└─attrField | string | false | 物模型属性字段 | ||
└─attrName | string | false | 属性名称 | ||
└─dataType | string | true | 属性类型 | ||
└─productId | int64 | true | 所属产品 | ||
└─remark | string | false | 备注 | ||
└─value | string | false | 配置值 | ||
└─modelAttrId | int64 | false | 模型属性id | ||
└─fieldType | enum | false | 字段类型 | ||
└─protocolDataType | string | true | 协议属性类型 | ||
└─protocolAttrField | string | true | 协议属性字段 | ||
└─protocolAttrName | string | false | 协议属性名称 | ||
└─createTime | string | false | 创建时间 | ||
└─direction | enum | false | 接口方向 | ||
└─accuracy | int32 | false | 精度 | ||
└─funcType | enum | false | 属性读写类型 | ||
└─attrDefaultValue | string | false | 属性默认值 | ||
└─gain | int32 | false | 数据增益 | ||
└─resolver | string | false | 数据解析器 | ||
└─script | string | false | 自定义解析脚本 | ||
└─dicts | array | false | 属性字典列表 | ||
└─id | int64 | false | No comments found. | ||
└─path | string | false | 路径 | ||
└─dictName | string | true | 字典名称 | ||
└─dictValue | string | true | 字典值 | ||
└─dataType | string | false | 数据类型 | ||
└─attrField | string | false | 属性字段 | ||
└─accuracy | int32 | false | 精度 | ||
└─gain | int32 | false | 数据增益 | ||
└─resolver | string | false | 数据解析器 | ||
└─script | string | false | 自定义解析脚本 | ||
└─modelAttrId | int64 | true | 模型属性id | ||
downConfig | array | false | 下行接口配置 | ||
└─id | int64 | false | No comments found. | ||
└─sort | int32 | false | 排序 | ||
└─apiCode | string | false | 接口码 | ||
└─attrField | string | false | 物模型属性字段 | ||
└─attrName | string | false | 属性名称 | ||
└─dataType | string | true | 属性类型 | ||
└─productId | int64 | true | 所属产品 | ||
└─remark | string | false | 备注 | ||
└─value | string | false | 配置值 | ||
└─modelAttrId | int64 | false | 模型属性id | ||
└─fieldType | enum | false | 字段类型 | ||
└─protocolDataType | string | true | 协议属性类型 | ||
└─protocolAttrField | string | true | 协议属性字段 | ||
└─protocolAttrName | string | false | 协议属性名称 | ||
└─createTime | string | false | 创建时间 | ||
└─direction | enum | false | 接口方向 | ||
└─accuracy | int32 | false | 精度 | ||
└─funcType | enum | false | 属性读写类型 | ||
└─attrDefaultValue | string | false | 属性默认值 | ||
└─gain | int32 | false | 数据增益 | ||
└─resolver | string | false | 数据解析器 | ||
└─script | string | false | 自定义解析脚本 | ||
└─dicts | array | false | 属性字典列表 | ||
└─id | int64 | false | No comments found. | ||
└─path | string | false | 路径 | ||
└─dictName | string | true | 字典名称 | ||
└─dictValue | string | true | 字典值 | ||
└─dataType | string | false | 数据类型 | ||
└─attrField | string | false | 属性字段 | ||
└─accuracy | int32 | false | 精度 | ||
└─gain | int32 | false | 数据增益 | ||
└─resolver | string | false | 数据解析器 | ||
└─script | string | false | 自定义解析脚本 | ||
└─modelAttrId | int64 | true | 模型属性id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─type | enum | 接口类型 | - |
└─direct | string | 协议指令 | - |
└─code | string | 功能代码 | - |
└─debug | boolean | 显示到调试 | - |
└─protocol | boolean | 是否为协议接口 | - |
└─productId | int64 | 所属产品 | - |
└─name | string | 接口名称 | - |
└─status | string | 接口状态 | - |
└─remark | string | 接口说明 | - |
└─asStatus | boolean | 作为状态位(用于点位控制协议) | - |
└─createTime | string | 创建时间 | - |
└─funcType | enum | 功能类型 | - |
└─productCode | string | No comments found. | - |
└─triggerMode | enum | 事件触发方式 | - |
└─directParams | object | 指令参数 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─_children | map | No comments found. | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─upConfig | array | 上行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─downConfig | array | 下行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"type": "func",
"direct": "",
"code": "",
"debug": true,
"protocol": true,
"productId": 0,
"name": "",
"status": "",
"remark": "",
"asStatus": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"funcType": "R",
"productCode": "",
"triggerMode": "active",
"directParams": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
},
"_children": {
"mapKey": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true
}
}
},
"upConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
],
"downConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
]
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/modelApi/view?size=0¤t=0&id=0&type=func&debug=true&protocol=true&productId=0&asStatus=true&createTime=yyyy-MM-dd HH:mm:ss&funcType=R&triggerMode=active&array=true&object=true&containerNode=true&valueNode=true&missingNode=true&_cfgBigDecimalExact=true&sort=0&modelAttrId=0&fieldType=status&direction=UP&accuracy=0&gain=0&downConfig[0].productId=0&upConfig[0].modelAttrId=0&directParams.valueNode=true&records[0].directParams.containerNode=true&orders[0].funcType=R&downConfig[0].remark=&records[0].upConfig[0].sort=0&orders[0].downConfig[0].accuracy=0&upConfig[0].attrField=&records[0].upConfig[0].attrName=&records[0].upConfig[0].dicts[0].accuracy=0&upConfig[0].sort=0&upConfig[0].value=&orders[0].upConfig[0].funcType=R&records[0].downConfig[0].dicts[0].resolver=&records[0].downConfig[0].resolver=&records[0].downConfig[0].dicts[0].path=&upConfig[0].accuracy=0&directParams.array=true&records[0].createTime=yyyy-MM-dd HH:mm:ss&orders[0].downConfig[0].direction=UP&upConfig[0].attrName=&downConfig[0].fieldType=status&hitCount=true&upConfig[0].dicts[0].dictValue=&downConfig[0].dicts[0].path=&orders[0].downConfig[0].dicts[0].dictName=&records[0].remark=&orders[0].direct=&orders[0].downConfig[0].dataType=&records[0].upConfig[0].attrField=&orders[0].upConfig[0].dicts[0].modelAttrId=0&orders[0].upConfig[0].productId=0&records[0].upConfig[0].dicts[0].resolver=&upConfig[0].dicts[0].script=&records[0].upConfig[0].remark=&records[0].upConfig[0].dicts[0].script=&orders[0].type=func&productCode=&records[0].upConfig[0].dataType=&directParams.object=true&upConfig[0].dicts[0].attrField=&orders[0].upConfig[0].script=&orders[0].directParams.array=true&records[0].downConfig[0].dicts[0].dictValue=&status=&orders[0].upConfig[0].dicts[0].dictName=&downConfig[0].protocolAttrField=&downConfig[0].id=0&records[0].upConfig[0].dicts[0].id=0&records[0].upConfig[0].fieldType=status&orders[0].upConfig[0].protocolAttrField=&records[0].productCode=&records[0].upConfig[0].gain=0&records[0].upConfig[0].id=0&records[0].downConfig[0].dicts[0].modelAttrId=0&records[0].upConfig[0].dicts[0].dictValue=&records[0].productId=0&orders[0].upConfig[0].fieldType=status&orders[0].downConfig[0].attrDefaultValue=&orders[0].remark=&orders[0].upConfig[0].dicts[0].script=&orders[0].downConfig[0].dicts[0].dataType=&downConfig[0].sort=0&records[0].downConfig[0].modelAttrId=0&orders[0].code=&records[0].downConfig[0].apiCode=&records[0].status=&records[0].downConfig[0].dicts[0].script=&orders[0].id=0&orders[0].asStatus=true&orders[0].downConfig[0].protocolAttrName=&upConfig[0].dicts[0].dataType=&orders[0].upConfig[0].remark=&downConfig[0].gain=0&records[0].asStatus=true&orders[0].createTime=yyyy-MM-dd HH:mm:ss&orders[0].downConfig[0].modelAttrId=0&directParams.containerNode=true&downConfig[0].resolver=&orders[0].downConfig[0].apiCode=&orders[0].downConfig[0].resolver=&records[0].upConfig[0].protocolAttrName=&orders[0].downConfig[0].gain=0&records[0].upConfig[0].protocolDataType=&records[0].downConfig[0].dicts[0].gain=0&orders[0].upConfig[0].attrDefaultValue=&orders[0].downConfig[0].productId=0&directParams.missingNode=true&orders[0].upConfig[0].dataType=&orders[0].protocol=true&orders[0].upConfig[0].dicts[0].dictValue=&orders[0].downConfig[0].sort=0&pages=0&orders[0].upConfig[0].value=&records[0].upConfig[0].accuracy=0&records[0].downConfig[0].funcType=R&records[0].downConfig[0].productId=0&upConfig[0].protocolDataType=&total=0&code=&remark=&downConfig[0].attrName=&orders[0].downConfig[0].funcType=R&records[0].upConfig[0].script=&records[0].upConfig[0].dicts[0].dictName=&downConfig[0].attrField=&directParams._nodeFactory._cfgBigDecimalExact=true&upConfig[0].dicts[0].resolver=&records[0].directParams.object=true&orders[0].downConfig[0].remark=&countId=&records[0].downConfig[0].attrField=&downConfig[0].accuracy=0&records[0].upConfig[0].resolver=&records[0].directParams._nodeFactory._cfgBigDecimalExact=true&records[0].upConfig[0].funcType=R&downConfig[0].dicts[0].id=0&downConfig[0].protocolAttrName=&records[0].triggerMode=active&records[0].upConfig[0].dicts[0].dataType=&orders[0].directParams.object=true&orders[0].upConfig[0].id=0&downConfig[0].dataType=&records[0].downConfig[0].id=0&records[0].directParams.array=true&records[0].upConfig[0].modelAttrId=0&orders[0].upConfig[0].dicts[0].gain=0&orders[0].downConfig[0].dicts[0].dictValue=&records[0].upConfig[0].protocolAttrField=&orders[0].productId=0&orders[0].downConfig[0].dicts[0].id=0&records[0].code=&orders[0].directParams.valueNode=true&orders[0].downConfig[0].id=0&upConfig[0].resolver=&records[0].downConfig[0].createTime=yyyy-MM-dd HH:mm:ss&orders[0].upConfig[0].accuracy=0&orders[0].upConfig[0].protocolAttrName=&orders[0].downConfig[0].protocolAttrField=&upConfig[0].dicts[0].dictName=&records[0].downConfig[0].accuracy=0&records[0].directParams.missingNode=true&records[0].upConfig[0].dicts[0].gain=0&orders[0].upConfig[0].resolver=&orders[0].upConfig[0].modelAttrId=0&orders[0].upConfig[0].dicts[0].attrField=&records[0].upConfig[0].apiCode=&orders[0].downConfig[0].createTime=yyyy-MM-dd HH:mm:ss&downConfig[0].dicts[0].attrField=&records[0].debug=true&downConfig[0].dicts[0].modelAttrId=0&upConfig[0].id=0&records[0].downConfig[0].protocolDataType=&orders[0].downConfig[0].attrField=&records[0].id=0&orders[0].downConfig[0].dicts[0].script=&records[0].downConfig[0].dicts[0].dictName=&orders[0].name=&upConfig[0].script=&downConfig[0].protocolDataType=&downConfig[0].modelAttrId=0&downConfig[0].script=&orders[0].directParams._nodeFactory._cfgBigDecimalExact=true&orders[0].downConfig[0].dicts[0].accuracy=0&records[0].upConfig[0].value=&records[0].downConfig[0].remark=&records[0].downConfig[0].dataType=&orders[0].status=&orders[0].directParams.missingNode=true&orders[0].upConfig[0].createTime=yyyy-MM-dd HH:mm:ss&maxLimit=0&upConfig[0].apiCode=&upConfig[0].dicts[0].gain=0&upConfig[0].dicts[0].path=&orders[0].upConfig[0].attrField=&records[0].downConfig[0].gain=0&orders[0].upConfig[0].protocolDataType=&orders[0].downConfig[0].fieldType=status&downConfig[0].value=&upConfig[0].attrDefaultValue=&records[0].downConfig[0].fieldType=status&orders[0].directParams.containerNode=true&orders[0].downConfig[0].script=&records[0].downConfig[0].protocolAttrField=&records[0].upConfig[0].attrDefaultValue=&optimizeCountSql=true&records[0].upConfig[0].dicts[0].attrField=&name=&orders[0].debug=true&orders[0].upConfig[0].attrName=&orders[0].upConfig[0].sort=0&downConfig[0].dicts[0].dictValue=&orders[0].downConfig[0].dicts[0].modelAttrId=0&orders[0].downConfig[0].value=&orders[0].upConfig[0].gain=0&isSearchCount=true&upConfig[0].protocolAttrName=&downConfig[0].createTime=yyyy-MM-dd HH:mm:ss&downConfig[0].dicts[0].dataType=&records[0].downConfig[0].direction=UP&upConfig[0].createTime=yyyy-MM-dd HH:mm:ss&orders[0].downConfig[0].dicts[0].gain=0&upConfig[0].dicts[0].id=0&orders[0].upConfig[0].dicts[0].dataType=&records[0].downConfig[0].sort=0&orders[0].upConfig[0].dicts[0].accuracy=0&upConfig[0].protocolAttrField=&records[0].funcType=R&records[0].downConfig[0].dicts[0].id=0&records[0].upConfig[0].createTime=yyyy-MM-dd HH:mm:ss&records[0].upConfig[0].dicts[0].path=&downConfig[0].dicts[0].script=&records[0].downConfig[0].dicts[0].accuracy=0&downConfig[0].apiCode=&records[0].downConfig[0].attrName=&downConfig[0].dicts[0].dictName=&downConfig[0].dicts[0].accuracy=0&records[0].downConfig[0].attrDefaultValue=&orders[0].upConfig[0].dicts[0].id=0&orders[0].upConfig[0].apiCode=&upConfig[0].direction=UP&records[0].direct=&downConfig[0].dicts[0].gain=0&records[0].upConfig[0].direction=UP&records[0].type=func&orders[0].upConfig[0].dicts[0].resolver=&upConfig[0].gain=0&upConfig[0].remark=&records[0].downConfig[0].script=&upConfig[0].productId=0&upConfig[0].funcType=R&downConfig[0].attrDefaultValue=&orders[0].downConfig[0].dicts[0].resolver=&downConfig[0].funcType=R&records[0].downConfig[0].dicts[0].attrField=&downConfig[0].direction=UP&upConfig[0].dicts[0].accuracy=0&orders[0].productCode=&orders[0].downConfig[0].dicts[0].attrField=&orders[0].downConfig[0].protocolDataType=&orders[0].upConfig[0].dicts[0].path=&orders[0].downConfig[0].dicts[0].path=&orders[0].downConfig[0].attrName=&records[0].upConfig[0].dicts[0].modelAttrId=0&direct=&records[0].protocol=true&records[0].name=&upConfig[0].dicts[0].modelAttrId=0&records[0].downConfig[0].value=&upConfig[0].dataType=&orders[0].upConfig[0].direction=UP&records[0].upConfig[0].productId=0&records[0].directParams.valueNode=true&records[0].downConfig[0].protocolAttrName=&records[0].downConfig[0].dicts[0].dataType=&orders[0].triggerMode=active&upConfig[0].fieldType=status&downConfig[0].dicts[0].resolver='2.20.2. 获取接口列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取接口列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. | ||
type | enum | true | 接口类型 | ||
direct | string | false | 协议指令 | ||
code | string | true | 功能代码 | ||
debug | boolean | false | 显示到调试 | ||
protocol | boolean | false | 是否为协议接口 | ||
productId | int64 | true | 所属产品 | ||
name | string | false | 接口名称 | ||
status | string | false | 接口状态 | ||
remark | string | false | 接口说明 | ||
asStatus | boolean | false | 作为状态位(用于点位控制协议) | ||
createTime | string | false | 创建时间 | ||
funcType | enum | false | 功能类型 | ||
productCode | string | false | No comments found. | ||
triggerMode | enum | false | 事件触发方式 | ||
directParams | object | false | 指令参数 | ||
└─array | boolean | false | No comments found. | ||
└─object | boolean | false | No comments found. | ||
└─containerNode | boolean | false | No comments found. | ||
└─valueNode | boolean | false | No comments found. | ||
└─missingNode | boolean | false | No comments found. | ||
└─_nodeFactory | object | false | No comments found. | ||
└─_cfgBigDecimalExact | boolean | false | No comments found. | ||
└─_children | map | false | No comments found. | ||
└─array | boolean | false | No comments found. | ||
└─object | boolean | false | No comments found. | ||
└─containerNode | boolean | false | No comments found. | ||
└─valueNode | boolean | false | No comments found. | ||
└─missingNode | boolean | false | No comments found. | ||
upConfig | array | false | 上行接口配置 | ||
└─id | int64 | false | No comments found. | ||
└─sort | int32 | false | 排序 | ||
└─apiCode | string | false | 接口码 | ||
└─attrField | string | false | 物模型属性字段 | ||
└─attrName | string | false | 属性名称 | ||
└─dataType | string | true | 属性类型 | ||
└─productId | int64 | true | 所属产品 | ||
└─remark | string | false | 备注 | ||
└─value | string | false | 配置值 | ||
└─modelAttrId | int64 | false | 模型属性id | ||
└─fieldType | enum | false | 字段类型 | ||
└─protocolDataType | string | true | 协议属性类型 | ||
└─protocolAttrField | string | true | 协议属性字段 | ||
└─protocolAttrName | string | false | 协议属性名称 | ||
└─createTime | string | false | 创建时间 | ||
└─direction | enum | false | 接口方向 | ||
└─accuracy | int32 | false | 精度 | ||
└─funcType | enum | false | 属性读写类型 | ||
└─attrDefaultValue | string | false | 属性默认值 | ||
└─gain | int32 | false | 数据增益 | ||
└─resolver | string | false | 数据解析器 | ||
└─script | string | false | 自定义解析脚本 | ||
└─dicts | array | false | 属性字典列表 | ||
└─id | int64 | false | No comments found. | ||
└─path | string | false | 路径 | ||
└─dictName | string | true | 字典名称 | ||
└─dictValue | string | true | 字典值 | ||
└─dataType | string | false | 数据类型 | ||
└─attrField | string | false | 属性字段 | ||
└─accuracy | int32 | false | 精度 | ||
└─gain | int32 | false | 数据增益 | ||
└─resolver | string | false | 数据解析器 | ||
└─script | string | false | 自定义解析脚本 | ||
└─modelAttrId | int64 | true | 模型属性id | ||
downConfig | array | false | 下行接口配置 | ||
└─id | int64 | false | No comments found. | ||
└─sort | int32 | false | 排序 | ||
└─apiCode | string | false | 接口码 | ||
└─attrField | string | false | 物模型属性字段 | ||
└─attrName | string | false | 属性名称 | ||
└─dataType | string | true | 属性类型 | ||
└─productId | int64 | true | 所属产品 | ||
└─remark | string | false | 备注 | ||
└─value | string | false | 配置值 | ||
└─modelAttrId | int64 | false | 模型属性id | ||
└─fieldType | enum | false | 字段类型 | ||
└─protocolDataType | string | true | 协议属性类型 | ||
└─protocolAttrField | string | true | 协议属性字段 | ||
└─protocolAttrName | string | false | 协议属性名称 | ||
└─createTime | string | false | 创建时间 | ||
└─direction | enum | false | 接口方向 | ||
└─accuracy | int32 | false | 精度 | ||
└─funcType | enum | false | 属性读写类型 | ||
└─attrDefaultValue | string | false | 属性默认值 | ||
└─gain | int32 | false | 数据增益 | ||
└─resolver | string | false | 数据解析器 | ||
└─script | string | false | 自定义解析脚本 | ||
└─dicts | array | false | 属性字典列表 | ||
└─id | int64 | false | No comments found. | ||
└─path | string | false | 路径 | ||
└─dictName | string | true | 字典名称 | ||
└─dictValue | string | true | 字典值 | ||
└─dataType | string | false | 数据类型 | ||
└─attrField | string | false | 属性字段 | ||
└─accuracy | int32 | false | 精度 | ||
└─gain | int32 | false | 数据增益 | ||
└─resolver | string | false | 数据解析器 | ||
└─script | string | false | 自定义解析脚本 | ||
└─modelAttrId | int64 | true | 模型属性id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─type | enum | 接口类型 | - |
└─direct | string | 协议指令 | - |
└─code | string | 功能代码 | - |
└─debug | boolean | 显示到调试 | - |
└─protocol | boolean | 是否为协议接口 | - |
└─productId | int64 | 所属产品 | - |
└─name | string | 接口名称 | - |
└─status | string | 接口状态 | - |
└─remark | string | 接口说明 | - |
└─asStatus | boolean | 作为状态位(用于点位控制协议) | - |
└─createTime | string | 创建时间 | - |
└─funcType | enum | 功能类型 | - |
└─productCode | string | No comments found. | - |
└─triggerMode | enum | 事件触发方式 | - |
└─directParams | object | 指令参数 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─_children | map | No comments found. | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─upConfig | array | 上行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─downConfig | array | 下行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"type": "func",
"direct": "",
"code": "",
"debug": true,
"protocol": true,
"productId": 0,
"name": "",
"status": "",
"remark": "",
"asStatus": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"funcType": "R",
"productCode": "",
"triggerMode": "active",
"directParams": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
},
"_children": {
"mapKey": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true
}
}
},
"upConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
],
"downConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
]
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/modelApi/list?id=0&type=func&debug=true&protocol=true&productId=0&asStatus=true&createTime=yyyy-MM-dd HH:mm:ss&funcType=R&triggerMode=active&array=true&object=true&containerNode=true&valueNode=true&missingNode=true&_cfgBigDecimalExact=true&sort=0&modelAttrId=0&fieldType=status&direction=UP&accuracy=0&gain=0&upConfig[0].dicts[0].resolver=&status=&upConfig[0].dicts[0].dataType=&downConfig[0].dicts[0].dictName=&downConfig[0].dicts[0].dictValue=&upConfig[0].funcType=R&upConfig[0].attrField=&downConfig[0].dicts[0].id=0&downConfig[0].funcType=R&productCode=&directParams.array=true&upConfig[0].protocolAttrField=&downConfig[0].dicts[0].script=&upConfig[0].dicts[0].modelAttrId=0&directParams.containerNode=true&code=&upConfig[0].productId=0&upConfig[0].direction=UP&downConfig[0].createTime=yyyy-MM-dd HH:mm:ss&downConfig[0].remark=&directParams._nodeFactory._cfgBigDecimalExact=true&upConfig[0].id=0&downConfig[0].protocolAttrName=&directParams.valueNode=true&downConfig[0].id=0&upConfig[0].dicts[0].attrField=&downConfig[0].attrName=&upConfig[0].gain=0&downConfig[0].modelAttrId=0&upConfig[0].dicts[0].gain=0&downConfig[0].dicts[0].attrField=&upConfig[0].dicts[0].accuracy=0&downConfig[0].productId=0&upConfig[0].value=&upConfig[0].sort=0&downConfig[0].apiCode=&downConfig[0].direction=UP&remark=&downConfig[0].resolver=&downConfig[0].protocolDataType=&directParams.missingNode=true&upConfig[0].attrName=&downConfig[0].dicts[0].path=&downConfig[0].dicts[0].modelAttrId=0&upConfig[0].fieldType=status&upConfig[0].attrDefaultValue=&upConfig[0].accuracy=0&upConfig[0].script=&upConfig[0].apiCode=&upConfig[0].resolver=&upConfig[0].dicts[0].script=&upConfig[0].modelAttrId=0&upConfig[0].dicts[0].id=0&upConfig[0].dicts[0].dictValue=&name=&downConfig[0].sort=0&downConfig[0].gain=0&downConfig[0].dicts[0].dataType=&directParams.object=true&upConfig[0].dataType=&downConfig[0].dicts[0].gain=0&downConfig[0].attrDefaultValue=&upConfig[0].createTime=yyyy-MM-dd HH:mm:ss&upConfig[0].remark=&downConfig[0].dicts[0].resolver=&upConfig[0].dicts[0].path=&downConfig[0].dataType=&downConfig[0].script=&downConfig[0].attrField=&downConfig[0].accuracy=0&upConfig[0].protocolDataType=&upConfig[0].dicts[0].dictName=&upConfig[0].protocolAttrName=&downConfig[0].protocolAttrField=&downConfig[0].dicts[0].accuracy=0&downConfig[0].value=&downConfig[0].fieldType=status&direct='2.20.3. 获取指定产品下面的接口列表详情
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取指定产品下面的接口列表详情
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
productId | int64 | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─type | enum | 接口类型 | - |
└─direct | string | 协议指令 | - |
└─code | string | 功能代码 | - |
└─debug | boolean | 显示到调试 | - |
└─protocol | boolean | 是否为协议接口 | - |
└─productId | int64 | 所属产品 | - |
└─name | string | 接口名称 | - |
└─status | string | 接口状态 | - |
└─remark | string | 接口说明 | - |
└─asStatus | boolean | 作为状态位(用于点位控制协议) | - |
└─createTime | string | 创建时间 | - |
└─funcType | enum | 功能类型 | - |
└─productCode | string | No comments found. | - |
└─triggerMode | enum | 事件触发方式 | - |
└─directParams | object | 指令参数 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─_children | map | No comments found. | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─upConfig | array | 上行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─downConfig | array | 下行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"type": "func",
"direct": "",
"code": "",
"debug": true,
"protocol": true,
"productId": 0,
"name": "",
"status": "",
"remark": "",
"asStatus": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"funcType": "R",
"productCode": "",
"triggerMode": "active",
"directParams": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
},
"_children": {
"mapKey": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true
}
}
},
"upConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
],
"downConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
]
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/modelApi/detailsOfProductId?productId=0&=6f6yfp'2.20.4. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | 记录id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─type | enum | 接口类型 | - |
└─direct | string | 协议指令 | - |
└─code | string | 功能代码 | - |
└─debug | boolean | 显示到调试 | - |
└─protocol | boolean | 是否为协议接口 | - |
└─productId | int64 | 所属产品 | - |
└─name | string | 接口名称 | - |
└─status | string | 接口状态 | - |
└─remark | string | 接口说明 | - |
└─asStatus | boolean | 作为状态位(用于点位控制协议) | - |
└─createTime | string | 创建时间 | - |
└─funcType | enum | 功能类型 | - |
└─productCode | string | No comments found. | - |
└─triggerMode | enum | 事件触发方式 | - |
└─directParams | object | 指令参数 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─_children | map | No comments found. | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─upConfig | array | 上行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─downConfig | array | 下行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"type": "func",
"direct": "",
"code": "",
"debug": true,
"protocol": true,
"productId": 0,
"name": "",
"status": "",
"remark": "",
"asStatus": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"funcType": "R",
"productCode": "",
"triggerMode": "active",
"directParams": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
},
"_children": {
"mapKey": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true
}
}
},
"upConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
],
"downConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
]
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/modelApi/edit?id=0&=renk4s'2.20.5. 新增或者更新记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
type | enum | true | 接口类型 |
direct | string | false | 协议指令 |
code | string | true | 功能代码 |
debug | boolean | false | 显示到调试 |
protocol | boolean | false | 是否为协议接口 |
productId | int64 | true | 所属产品 |
name | string | false | 接口名称 |
status | string | false | 接口状态 |
remark | string | false | 接口说明 |
asStatus | boolean | false | 作为状态位(用于点位控制协议) |
createTime | string | false | 创建时间 |
funcType | enum | false | 功能类型 |
productCode | string | false | No comments found. |
triggerMode | enum | false | 事件触发方式 |
directParams | object | false | 指令参数 |
└─array | boolean | false | No comments found. |
└─object | boolean | false | No comments found. |
└─containerNode | boolean | false | No comments found. |
└─valueNode | boolean | false | No comments found. |
└─missingNode | boolean | false | No comments found. |
└─_nodeFactory | object | false | No comments found. |
└─_cfgBigDecimalExact | boolean | false | No comments found. |
└─_children | map | false | No comments found. |
└─array | boolean | false | No comments found. |
└─object | boolean | false | No comments found. |
└─containerNode | boolean | false | No comments found. |
└─valueNode | boolean | false | No comments found. |
└─missingNode | boolean | false | No comments found. |
upConfig | array | false | 上行接口配置 |
└─id | int64 | false | No comments found. |
└─sort | int32 | false | 排序 |
└─apiCode | string | false | 接口码 |
└─attrField | string | false | 物模型属性字段 |
└─attrName | string | false | 属性名称 |
└─dataType | string | true | 属性类型 |
└─productId | int64 | true | 所属产品 |
└─remark | string | false | 备注 |
└─value | string | false | 配置值 |
└─modelAttrId | int64 | false | 模型属性id |
└─fieldType | enum | false | 字段类型 |
└─protocolDataType | string | true | 协议属性类型 |
└─protocolAttrField | string | true | 协议属性字段 |
└─protocolAttrName | string | false | 协议属性名称 |
└─createTime | string | false | 创建时间 |
└─direction | enum | false | 接口方向 |
└─accuracy | int32 | false | 精度 |
└─funcType | enum | false | 属性读写类型 |
└─attrDefaultValue | string | false | 属性默认值 |
└─gain | int32 | false | 数据增益 |
└─resolver | string | false | 数据解析器 |
└─script | string | false | 自定义解析脚本 |
└─dicts | array | false | 属性字典列表 |
└─id | int64 | false | No comments found. |
└─path | string | false | 路径 |
└─dictName | string | true | 字典名称 |
└─dictValue | string | true | 字典值 |
└─dataType | string | false | 数据类型 |
└─attrField | string | false | 属性字段 |
└─accuracy | int32 | false | 精度 |
└─gain | int32 | false | 数据增益 |
└─resolver | string | false | 数据解析器 |
└─script | string | false | 自定义解析脚本 |
└─modelAttrId | int64 | true | 模型属性id |
downConfig | array | false | 下行接口配置 |
└─id | int64 | false | No comments found. |
└─sort | int32 | false | 排序 |
└─apiCode | string | false | 接口码 |
└─attrField | string | false | 物模型属性字段 |
└─attrName | string | false | 属性名称 |
└─dataType | string | true | 属性类型 |
└─productId | int64 | true | 所属产品 |
└─remark | string | false | 备注 |
└─value | string | false | 配置值 |
└─modelAttrId | int64 | false | 模型属性id |
└─fieldType | enum | false | 字段类型 |
└─protocolDataType | string | true | 协议属性类型 |
└─protocolAttrField | string | true | 协议属性字段 |
└─protocolAttrName | string | false | 协议属性名称 |
└─createTime | string | false | 创建时间 |
└─direction | enum | false | 接口方向 |
└─accuracy | int32 | false | 精度 |
└─funcType | enum | false | 属性读写类型 |
└─attrDefaultValue | string | false | 属性默认值 |
└─gain | int32 | false | 数据增益 |
└─resolver | string | false | 数据解析器 |
└─script | string | false | 自定义解析脚本 |
└─dicts | array | false | 属性字典列表 |
└─id | int64 | false | No comments found. |
└─path | string | false | 路径 |
└─dictName | string | true | 字典名称 |
└─dictValue | string | true | 字典值 |
└─dataType | string | false | 数据类型 |
└─attrField | string | false | 属性字段 |
└─accuracy | int32 | false | 精度 |
└─gain | int32 | false | 数据增益 |
└─resolver | string | false | 数据解析器 |
└─script | string | false | 自定义解析脚本 |
└─modelAttrId | int64 | true | 模型属性id |
Request-body:
{
"id": 0,
"type": "func",
"direct": "",
"code": "",
"debug": true,
"protocol": true,
"productId": 0,
"name": "",
"status": "",
"remark": "",
"asStatus": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"funcType": "R",
"productCode": "",
"triggerMode": "active",
"directParams": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
},
"_children": {
"mapKey": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true
}
}
},
"upConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
],
"downConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
]
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/modelApi/saveOrUpdate' --data '{
"id": 0,
"type": "func",
"direct": "",
"code": "",
"debug": true,
"protocol": true,
"productId": 0,
"name": "",
"status": "",
"remark": "",
"asStatus": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"funcType": "R",
"productCode": "",
"triggerMode": "active",
"directParams": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
},
"_children": {
"mapKey": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true
}
}
},
"upConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
],
"downConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
]
}'2.20.6. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/modelApi/del' --data '[
0
]'2.20.7. 修改默认状态位
Type: POST
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 修改默认状态位
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
productId | int64 | false | 产品id | ||
code | string | false | 接口代码 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -i 'http://127.0.0.1:8085/api/iot/modelApi/asStatus' --data 'productId=0&=9jmmtu'2.21. 物模型属性管理
2.21.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
productId | int64 | true | 所属产品 | ||
field | string | true | 属性代码 | ||
name | string | true | 属性名称 | ||
dataType | string | true | 数据类型 | ||
realType | string | false | 实际类型 | ||
attrType | enum | false | 读写方式 | ||
enumerate | boolean | false | 是否枚举 | ||
defaultValue | string | false | 默认值 | ||
unit | string | false | 单位 | ||
accuracy | int32 | false | 精度 | ||
gain | int32 | false | 数据增益 | ||
resolver | string | false | 数据解析器 | ||
script | string | false | 自定义解析脚本 | ||
remark | string | false | 描述 | ||
origin | enum | true | 属性来源 | ||
ctrlStatus | boolean | false | 是否属于控制状态 | ||
createTime | string | false | 创建时间 | ||
dicts | array | false | 属性字典列表 | ||
└─id | int64 | false | No comments found. | ||
└─path | string | false | 路径 | ||
└─dictName | string | true | 字典名称 | ||
└─dictValue | string | true | 字典值 | ||
└─dataType | string | false | 数据类型 | ||
└─attrField | string | false | 属性字段 | ||
└─accuracy | int32 | false | 精度 | ||
└─gain | int32 | false | 数据增益 | ||
└─resolver | string | false | 数据解析器 | ||
└─script | string | false | 自定义解析脚本 | ||
└─modelAttrId | int64 | true | 模型属性id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─productId | int64 | 所属产品 | - |
└─field | string | 属性代码 | - |
└─name | string | 属性名称 | - |
└─dataType | string | 数据类型 | - |
└─realType | string | 实际类型 | - |
└─attrType | enum | 读写方式 | - |
└─enumerate | boolean | 是否枚举 | - |
└─defaultValue | string | 默认值 | - |
└─unit | string | 单位 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─remark | string | 描述 | - |
└─origin | enum | 属性来源 | - |
└─ctrlStatus | boolean | 是否属于控制状态 | - |
└─createTime | string | 创建时间 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"productId": 0,
"field": "",
"name": "",
"dataType": "",
"realType": "",
"attrType": "R",
"enumerate": true,
"defaultValue": "",
"unit": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"remark": "",
"origin": "Protocol",
"ctrlStatus": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/modelAttr/view?size=0¤t=0&id=0&productId=0&attrType=R&enumerate=true&accuracy=0&gain=0&origin=Protocol&ctrlStatus=true&createTime=yyyy-MM-dd HH:mm:ss&modelAttrId=0&dicts[0].dataType=&orders[0].defaultValue=&records[0].dicts[0].dictName=&orders[0].resolver=&orders[0].realType=&orders[0].dicts[0].script=&dicts[0].dictName=&records[0].dicts[0].resolver=&records[0].enumerate=true&dataType=&records[0].origin=Protocol&maxLimit=0&orders[0].dataType=&realType=&records[0].ctrlStatus=true&records[0].script=&orders[0].id=0&records[0].defaultValue=&dicts[0].gain=0&orders[0].dicts[0].path=&records[0].id=0&dicts[0].script=&orders[0].field=&records[0].resolver=&orders[0].dicts[0].attrField=&records[0].dicts[0].path=&orders[0].accuracy=0&records[0].dicts[0].gain=0&orders[0].dicts[0].resolver=&dicts[0].modelAttrId=0&orders[0].dicts[0].dictName=&field=&pages=0&records[0].dicts[0].id=0&records[0].attrType=R&orders[0].createTime=yyyy-MM-dd HH:mm:ss&dicts[0].dictValue=&name=&orders[0].dicts[0].accuracy=0&records[0].field=&records[0].unit=&records[0].dicts[0].dataType=&orders[0].origin=Protocol&dicts[0].path=&records[0].realType=&isSearchCount=true&dicts[0].resolver=&records[0].dicts[0].dictValue=&orders[0].productId=0&orders[0].attrType=R&orders[0].dicts[0].dictValue=&orders[0].dicts[0].dataType=&records[0].dicts[0].attrField=&orders[0].dicts[0].modelAttrId=0&records[0].createTime=yyyy-MM-dd HH:mm:ss&hitCount=true&orders[0].name=&dicts[0].attrField=&script=&orders[0].ctrlStatus=true&unit=&resolver=&orders[0].unit=&countId=&orders[0].enumerate=true&dicts[0].accuracy=0&optimizeCountSql=true&records[0].dicts[0].script=&records[0].remark=&records[0].dataType=&total=0&records[0].accuracy=0&records[0].dicts[0].modelAttrId=0&orders[0].gain=0&remark=&records[0].gain=0&orders[0].script=&records[0].name=&dicts[0].id=0&defaultValue=&records[0].dicts[0].accuracy=0&records[0].productId=0&orders[0].dicts[0].gain=0&orders[0].dicts[0].id=0&orders[0].remark='2.21.2. 物模型属性字典列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 物模型属性字典列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. | ||
path | string | false | 路径 | ||
dictName | string | true | 字典名称 | ||
dictValue | string | true | 字典值 | ||
dataType | string | false | 数据类型 | ||
attrField | string | false | 属性字段 | ||
accuracy | int32 | false | 精度 | ||
gain | int32 | false | 数据增益 | ||
resolver | string | false | 数据解析器 | ||
script | string | false | 自定义解析脚本 | ||
modelAttrId | int64 | true | 模型属性id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/modelAttr/dict/view?id=0&accuracy=0&gain=0&modelAttrId=0&dictValue=&attrField=&path=&resolver=&script=&dictName=&dataType='2.21.3. 获取物模型属性列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取物模型属性列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. | ||
productId | int64 | true | 所属产品 | ||
field | string | true | 属性代码 | ||
name | string | true | 属性名称 | ||
dataType | string | true | 数据类型 | ||
realType | string | false | 实际类型 | ||
attrType | enum | false | 读写方式 | ||
enumerate | boolean | false | 是否枚举 | ||
defaultValue | string | false | 默认值 | ||
unit | string | false | 单位 | ||
accuracy | int32 | false | 精度 | ||
gain | int32 | false | 数据增益 | ||
resolver | string | false | 数据解析器 | ||
script | string | false | 自定义解析脚本 | ||
remark | string | false | 描述 | ||
origin | enum | true | 属性来源 | ||
ctrlStatus | boolean | false | 是否属于控制状态 | ||
createTime | string | false | 创建时间 | ||
dicts | array | false | 属性字典列表 | ||
└─id | int64 | false | No comments found. | ||
└─path | string | false | 路径 | ||
└─dictName | string | true | 字典名称 | ||
└─dictValue | string | true | 字典值 | ||
└─dataType | string | false | 数据类型 | ||
└─attrField | string | false | 属性字段 | ||
└─accuracy | int32 | false | 精度 | ||
└─gain | int32 | false | 数据增益 | ||
└─resolver | string | false | 数据解析器 | ||
└─script | string | false | 自定义解析脚本 | ||
└─modelAttrId | int64 | true | 模型属性id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─productId | int64 | 所属产品 | - |
└─field | string | 属性代码 | - |
└─name | string | 属性名称 | - |
└─dataType | string | 数据类型 | - |
└─realType | string | 实际类型 | - |
└─attrType | enum | 读写方式 | - |
└─enumerate | boolean | 是否枚举 | - |
└─defaultValue | string | 默认值 | - |
└─unit | string | 单位 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─remark | string | 描述 | - |
└─origin | enum | 属性来源 | - |
└─ctrlStatus | boolean | 是否属于控制状态 | - |
└─createTime | string | 创建时间 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"productId": 0,
"field": "",
"name": "",
"dataType": "",
"realType": "",
"attrType": "R",
"enumerate": true,
"defaultValue": "",
"unit": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"remark": "",
"origin": "Protocol",
"ctrlStatus": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/modelAttr/list?id=0&productId=0&attrType=R&enumerate=true&accuracy=0&gain=0&origin=Protocol&ctrlStatus=true&createTime=yyyy-MM-dd HH:mm:ss&modelAttrId=0&dicts[0].resolver=&field=&dicts[0].path=&dicts[0].dataType=&dataType=&dicts[0].attrField=&dicts[0].accuracy=0&dicts[0].gain=0&dicts[0].dictName=&defaultValue=&dicts[0].id=0&name=&realType=&resolver=&script=&remark=&dicts[0].dictValue=&dicts[0].modelAttrId=0&unit=&dicts[0].script='2.21.4. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | 记录id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─productId | int64 | 所属产品 | - |
└─field | string | 属性代码 | - |
└─name | string | 属性名称 | - |
└─dataType | string | 数据类型 | - |
└─realType | string | 实际类型 | - |
└─attrType | enum | 读写方式 | - |
└─enumerate | boolean | 是否枚举 | - |
└─defaultValue | string | 默认值 | - |
└─unit | string | 单位 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─remark | string | 描述 | - |
└─origin | enum | 属性来源 | - |
└─ctrlStatus | boolean | 是否属于控制状态 | - |
└─createTime | string | 创建时间 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"productId": 0,
"field": "",
"name": "",
"dataType": "",
"realType": "",
"attrType": "R",
"enumerate": true,
"defaultValue": "",
"unit": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"remark": "",
"origin": "Protocol",
"ctrlStatus": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/modelAttr/edit?id=0&=nhph2b'2.21.5. 新增或者更新记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
productId | int64 | true | 所属产品 |
field | string | true | 属性代码 |
name | string | true | 属性名称 |
dataType | string | true | 数据类型 |
realType | string | false | 实际类型 |
attrType | enum | false | 读写方式 |
enumerate | boolean | false | 是否枚举 |
defaultValue | string | false | 默认值 |
unit | string | false | 单位 |
accuracy | int32 | false | 精度 |
gain | int32 | false | 数据增益 |
resolver | string | false | 数据解析器 |
script | string | false | 自定义解析脚本 |
remark | string | false | 描述 |
origin | enum | true | 属性来源 |
ctrlStatus | boolean | false | 是否属于控制状态 |
createTime | string | false | 创建时间 |
dicts | array | false | 属性字典列表 |
└─id | int64 | false | No comments found. |
└─path | string | false | 路径 |
└─dictName | string | true | 字典名称 |
└─dictValue | string | true | 字典值 |
└─dataType | string | false | 数据类型 |
└─attrField | string | false | 属性字段 |
└─accuracy | int32 | false | 精度 |
└─gain | int32 | false | 数据增益 |
└─resolver | string | false | 数据解析器 |
└─script | string | false | 自定义解析脚本 |
└─modelAttrId | int64 | true | 模型属性id |
Request-body:
{
"id": 0,
"productId": 0,
"field": "",
"name": "",
"dataType": "",
"realType": "",
"attrType": "R",
"enumerate": true,
"defaultValue": "",
"unit": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"remark": "",
"origin": "Protocol",
"ctrlStatus": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | int64 | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": 0
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/modelAttr/saveOrUpdate' --data '{
"id": 0,
"productId": 0,
"field": "",
"name": "",
"dataType": "",
"realType": "",
"attrType": "R",
"enumerate": true,
"defaultValue": "",
"unit": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"remark": "",
"origin": "Protocol",
"ctrlStatus": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}'2.21.6. 新增或者更新记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
path | string | false | 路径 |
dictName | string | true | 字典名称 |
dictValue | string | true | 字典值 |
dataType | string | false | 数据类型 |
attrField | string | false | 属性字段 |
accuracy | int32 | false | 精度 |
gain | int32 | false | 数据增益 |
resolver | string | false | 数据解析器 |
script | string | false | 自定义解析脚本 |
modelAttrId | int64 | true | 模型属性id |
Request-body:
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/modelAttr/dict/saveOrUpdate' --data '{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}'2.21.7. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/modelAttr/del' --data '[
0
]'2.21.8. 删除指定物模型字典记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除指定物模型字典记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/modelAttr/dict/del' --data '[
0
]'2.21.9. 设置属性指定属性为控制属性
Type: POST
Author: iteaj
Content-Type: application/json
Description: 设置属性指定属性为控制属性
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | 操作id |
status | boolean | false | 操作状态 |
Request-body:
{
"id": 0,
"status": true
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/modelAttr/ctrlStatus' --data '{
"id": 0,
"status": true
}'2.21.10. 获取指定产品下面的物模型属性
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取指定产品下面的物模型属性
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
productId | int64 | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─productId | int64 | 所属产品 | - |
└─field | string | 属性代码 | - |
└─name | string | 属性名称 | - |
└─dataType | string | 数据类型 | - |
└─realType | string | 实际类型 | - |
└─attrType | enum | 读写方式 | - |
└─enumerate | boolean | 是否枚举 | - |
└─defaultValue | string | 默认值 | - |
└─unit | string | 单位 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─remark | string | 描述 | - |
└─origin | enum | 属性来源 | - |
└─ctrlStatus | boolean | 是否属于控制状态 | - |
└─createTime | string | 创建时间 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"productId": 0,
"field": "",
"name": "",
"dataType": "",
"realType": "",
"attrType": "R",
"enumerate": true,
"defaultValue": "",
"unit": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"remark": "",
"origin": "Protocol",
"ctrlStatus": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/modelAttr/listByProductId?productId=0&=uub5vo'2.22. 运行展板模块
2.22.1. 设备列表
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 设备列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
deviceGroupId | int64 | false | 设备分组 | ||
productId | int64 | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─options | array | 控制设备状态控制项 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─disabled | boolean | 是否禁用 | - |
└─checked | boolean | 是否默认选中 | - |
└─children | array | 子项 | - |
└─extra | object | 额外扩展信息 | - |
└─selectable | boolean | 可选中 | - |
└─checkable | boolean | 复选框是否能被选中 | - |
└─config | map | 配置项 | - |
└─any object | object | any object. | - |
└─ctrlValue | string | 控制值 | - |
└─values | array | 各属性值 | - |
└─field | string | 属性字段 | - |
└─name | string | 属性名称 | - |
└─unit | string | 属性单位 | - |
└─value | string | 属性最新值 | - |
└─label | string | 值标签 | - |
└─device | object | 设备 | - |
└─id | int64 | No comments found. | - |
└─ip | string | 设备ip | - |
└─pid | int64 | 父网关设备 | - |
└─uid | string | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─extend | string | 拓展字段 | - |
└─productId | int64 | 所属产品 | - |
└─deviceGroupId | int64 | 所属组 | - |
└─productTypeId | int64 | 设备类型 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─parentDeviceSn | string | 父设备编号 | - |
└─config | object | 设备配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | 新增时间 | - |
└─updateTime | string | 更新时间 | - |
└─deviceType | enum | 设备类型 | - |
└─gatewayId | int64 | 所属网关 | - |
└─gatewayName | string | 网关名称 | - |
└─connectType | enum | 连接类型 | - |
└─productCode | string | 产品代码 | - |
└─productName | string | 产品名称 | - |
└─protocolCode | string | 协议码 | - |
└─productTypeName | string | 产品类型名称 | - |
└─deviceGroupName | string | 所属分组 | - |
└─alias | enum | 设备别名 | - |
└─protocolCodes | array | 协议码列表 | - |
└─protocol | enum | 协议类型 | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"disabled": true,
"checked": true,
"children": [
{
"$ref": ".."
}
],
"extra": {
"object": "any object"
},
"selectable": true,
"checkable": true,
"config": {
"mapKey": {}
}
}
],
"ctrlValue": "",
"values": [
{
"field": "",
"name": "",
"unit": "",
"value": "",
"label": ""
}
],
"device": {
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"deviceType": "Direct",
"gatewayId": 0,
"gatewayName": "",
"connectType": "Client",
"productCode": "",
"productName": "",
"protocolCode": "",
"productTypeName": "",
"deviceGroupName": "",
"alias": "PLC",
"protocolCodes": [
""
],
"protocol": "TCP"
}
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/panels/devices?size=0¤t=0&deviceGroupId=0&productId=0&total=0&hitCount=true&optimizeCountSql=true&maxLimit=0&isSearchCount=true&=wkw6kz&pages=0&countId='2.22.2. 调试详情
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 调试详情
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
deviceId | int64 | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─device | object | 设备信息 | - |
└─id | int64 | No comments found. | - |
└─ip | string | 设备ip | - |
└─pid | int64 | 父网关设备 | - |
└─uid | string | 设备uid | - |
└─name | string | 设备名称 | - |
└─port | int32 | 设备端口 | - |
└─extend | string | 拓展字段 | - |
└─productId | int64 | 所属产品 | - |
└─deviceGroupId | int64 | 所属组 | - |
└─productTypeId | int64 | 设备类型 | - |
└─lon | string | 经度 | - |
└─lat | string | 纬度 | - |
└─address | string | 地址 | - |
└─account | string | 设备账号 | - |
└─password | string | 设备密码 | - |
└─status | enum | 设备状态 | - |
└─deviceSn | string | 设备编号 | - |
└─parentDeviceSn | string | 父设备编号 | - |
└─config | object | 设备配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─switchTime | string | 状态切换时间 | - |
└─createTime | string | 新增时间 | - |
└─updateTime | string | 更新时间 | - |
└─deviceType | enum | 设备类型 | - |
└─gatewayId | int64 | 所属网关 | - |
└─gatewayName | string | 网关名称 | - |
└─connectType | enum | 连接类型 | - |
└─productCode | string | 产品代码 | - |
└─productName | string | 产品名称 | - |
└─protocolCode | string | 协议码 | - |
└─productTypeName | string | 产品类型名称 | - |
└─deviceGroupName | string | 所属分组 | - |
└─alias | enum | 设备别名 | - |
└─protocolCodes | array | 协议码列表 | - |
└─protocol | enum | 协议类型 | - |
└─product | object | 产品信息 | - |
└─id | int64 | No comments found. | - |
└─logo | string | 图标 | - |
└─status | enum | 产品状态 | - |
└─code | string | 产品代码 | - |
└─deviceType | enum | 设备类型 | - |
└─productTypeId | int64 | 产品类型 | - |
└─typeName | string | 类型名称 | - |
└─name | string | 产品名称 | - |
└─parentId | int64 | 父产品id | - |
└─gatewayId | int64 | 绑定的网关 | - |
└─protocolId | int64 | 绑定的协议 | - |
└─config | object | 产品配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─remark | string | 产品说明 | - |
└─createTime | string | 创建时间 | - |
└─gatewayType | enum | 网关类型 | - |
└─gatewayName | string | 网关名称 | - |
└─protocolName | string | 协议名称 | - |
└─protocolCode | string | 协议代码 | - |
└─connectType | enum | 网关连接类型 | - |
└─deviceCount | int32 | 设备数量 | - |
└─ctrlMode | enum | 操作类型 | - |
└─gatewayStatus | enum | 网关状态 | - |
└─transportProtocol | enum | 传输协议 | - |
└─attrs | array | 物模型属性 | - |
└─id | int64 | No comments found. | - |
└─productId | int64 | 所属产品 | - |
└─field | string | 属性代码 | - |
└─name | string | 属性名称 | - |
└─dataType | string | 数据类型 | - |
└─realType | string | 实际类型 | - |
└─attrType | enum | 读写方式 | - |
└─enumerate | boolean | 是否枚举 | - |
└─defaultValue | string | 默认值 | - |
└─unit | string | 单位 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─remark | string | 描述 | - |
└─origin | enum | 属性来源 | - |
└─ctrlStatus | boolean | 是否属于控制状态 | - |
└─createTime | string | 创建时间 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─funcApis | array | 物模型功能接口 | - |
└─id | int64 | No comments found. | - |
└─type | enum | 接口类型 | - |
└─direct | string | 协议指令 | - |
└─code | string | 功能代码 | - |
└─debug | boolean | 显示到调试 | - |
└─protocol | boolean | 是否为协议接口 | - |
└─productId | int64 | 所属产品 | - |
└─name | string | 接口名称 | - |
└─status | string | 接口状态 | - |
└─remark | string | 接口说明 | - |
└─asStatus | boolean | 作为状态位(用于点位控制协议) | - |
└─createTime | string | 创建时间 | - |
└─funcType | enum | 功能类型 | - |
└─productCode | string | No comments found. | - |
└─triggerMode | enum | 事件触发方式 | - |
└─directParams | object | 指令参数 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─_children | map | No comments found. | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─upConfig | array | 上行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─downConfig | array | 下行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─eventApis | array | 物模型事件接口 | - |
└─id | int64 | No comments found. | - |
└─type | enum | 接口类型 | - |
└─direct | string | 协议指令 | - |
└─code | string | 功能代码 | - |
└─debug | boolean | 显示到调试 | - |
└─protocol | boolean | 是否为协议接口 | - |
└─productId | int64 | 所属产品 | - |
└─name | string | 接口名称 | - |
└─status | string | 接口状态 | - |
└─remark | string | 接口说明 | - |
└─asStatus | boolean | 作为状态位(用于点位控制协议) | - |
└─createTime | string | 创建时间 | - |
└─funcType | enum | 功能类型 | - |
└─productCode | string | No comments found. | - |
└─triggerMode | enum | 事件触发方式 | - |
└─directParams | object | 指令参数 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─_children | map | No comments found. | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─upConfig | array | 上行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─downConfig | array | 下行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─attrs | array | 模型属性列表 | - |
└─field | string | 属性代码 | - |
└─name | string | 属性名称 | - |
└─unit | string | 单位 | - |
└─value | object | 实时值 | - |
└─attrType | enum | 读写方式 | - |
└─collectTime | string | 采集时间 | - |
└─status | enum | No comments found. | - |
└─signals | array | 点位信息 | - |
└─name | string | 点位名称 | - |
└─value | object | 实时值 | - |
└─address | string | 地位地址 | - |
└─collectTime | string | 采集时间 | - |
└─status | enum | No comments found. | - |
└─apiCodeDebugMap | map | 接口调试参数 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─disabled | boolean | 是否禁用 | - |
└─checked | boolean | 是否默认选中 | - |
└─children | array | 子项 | - |
└─extra | object | 额外扩展信息 | - |
└─selectable | boolean | 可选中 | - |
└─checkable | boolean | 复选框是否能被选中 | - |
└─config | map | 配置项 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"device": {
"id": 0,
"ip": "",
"pid": 0,
"uid": "",
"name": "",
"port": 0,
"extend": "",
"productId": 0,
"deviceGroupId": 0,
"productTypeId": 0,
"lon": "",
"lat": "",
"address": "",
"account": "",
"password": "",
"status": "online",
"deviceSn": "",
"parentDeviceSn": "",
"config": {
"map": {
"mapKey": {}
}
},
"switchTime": "yyyy-MM-dd HH:mm:ss",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"deviceType": "Direct",
"gatewayId": 0,
"gatewayName": "",
"connectType": "Client",
"productCode": "",
"productName": "",
"protocolCode": "",
"productTypeName": "",
"deviceGroupName": "",
"alias": "PLC",
"protocolCodes": [
""
],
"protocol": "TCP"
},
"product": {
"id": 0,
"logo": "",
"status": "enabled",
"code": "",
"deviceType": "Direct",
"productTypeId": 0,
"typeName": "",
"name": "",
"parentId": 0,
"gatewayId": 0,
"protocolId": 0,
"config": {
"map": {
"mapKey": {}
}
},
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"gatewayType": "Direct",
"gatewayName": "",
"protocolName": "",
"protocolCode": "",
"connectType": "Client",
"deviceCount": 0,
"ctrlMode": "COMMON",
"gatewayStatus": "stop",
"transportProtocol": "TCP",
"attrs": [
{
"id": 0,
"productId": 0,
"field": "",
"name": "",
"dataType": "",
"realType": "",
"attrType": "R",
"enumerate": true,
"defaultValue": "",
"unit": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"remark": "",
"origin": "Protocol",
"ctrlStatus": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
],
"funcApis": [
{
"id": 0,
"type": "func",
"direct": "",
"code": "",
"debug": true,
"protocol": true,
"productId": 0,
"name": "",
"status": "",
"remark": "",
"asStatus": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"funcType": "R",
"productCode": "",
"triggerMode": "active",
"directParams": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
},
"_children": {
"mapKey": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true
}
}
},
"upConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
],
"downConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
]
}
],
"eventApis": [
{
"id": 0,
"type": "func",
"direct": "",
"code": "",
"debug": true,
"protocol": true,
"productId": 0,
"name": "",
"status": "",
"remark": "",
"asStatus": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"funcType": "R",
"productCode": "",
"triggerMode": "active",
"directParams": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
},
"_children": {
"mapKey": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true
}
}
},
"upConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
],
"downConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
]
}
]
},
"attrs": [
{
"field": "",
"name": "",
"unit": "",
"value": {
"object": "any object"
},
"attrType": "R",
"collectTime": "yyyy-MM-dd HH:mm:ss",
"status": "Success"
}
],
"signals": [
{
"name": "",
"value": {
"object": "any object"
},
"address": "",
"collectTime": "yyyy-MM-dd HH:mm:ss",
"status": "Success"
}
],
"apiCodeDebugMap": {
"mapKey": {}
}
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/panels/detail?deviceId=0&=n5jv3n'2.22.3. 切换控制状态
Type: POST
Content-Type: application/json
Description: 切换控制状态
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | 操作id |
status | object | false | 操作状态 |
Request-body:
{
"id": 0,
"status": {}
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/panels/switchCtrlStatus' --data '{
"id": 0,
"status": {}
}'2.23. 点位组管理
2.23.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
name | string | false | 组名称 | ||
signalNum | int32 | false | 点位数量 | ||
signalId | int64 | false | 点位id | ||
productIds | object | false | 产品id列表 | ||
└─array | boolean | false | No comments found. | ||
└─object | boolean | false | No comments found. | ||
└─containerNode | boolean | false | No comments found. | ||
└─valueNode | boolean | false | No comments found. | ||
└─missingNode | boolean | false | No comments found. | ||
└─_nodeFactory | object | false | No comments found. | ||
└─_cfgBigDecimalExact | boolean | false | No comments found. | ||
└─_children | array | false | No comments found. | ||
productNames | string | false | No comments found. | ||
signalIds | array | false | 点位信号列表 | ||
productId | int64 | false | No comments found. | ||
productTypeId | int64 | false | No comments found. | ||
createTime | string | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─name | string | 组名称 | - |
└─signalNum | int32 | 点位数量 | - |
└─signalId | int64 | 点位id | - |
└─productIds | object | 产品id列表 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─_children | array | No comments found. | - |
└─productNames | string | No comments found. | - |
└─signalIds | array | 点位信号列表 | - |
└─productId | int64 | No comments found. | - |
└─productTypeId | int64 | No comments found. | - |
└─createTime | string | No comments found. | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"name": "",
"signalNum": 0,
"signalId": 0,
"productIds": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
},
"_children": [
{
"object": "any object"
}
]
},
"productNames": "",
"signalIds": [
""
],
"productId": 0,
"productTypeId": 0,
"createTime": "yyyy-MM-dd HH:mm:ss"
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/pointGroup/view?size=0¤t=0&id=0&signalNum=0&signalId=0&array=true&object=true&containerNode=true&valueNode=true&missingNode=true&_cfgBigDecimalExact=true&signalIds=,&productId=0&productTypeId=0&createTime=yyyy-MM-dd HH:mm:ss&orders[0].createTime=yyyy-MM-dd HH:mm:ss&records[0].productTypeId=0&orders[0].productIds.missingNode=true&pages=0&records[0].signalId=0&orders[0].signalIds=,&records[0].productNames=&orders[0].productIds.containerNode=true&orders[0].productIds._nodeFactory._cfgBigDecimalExact=true&productIds.missingNode=true&orders[0].productIds.object=true&orders[0].productId=0&orders[0].name=&productNames=&records[0].signalIds=,&records[0].createTime=yyyy-MM-dd HH:mm:ss&countId=&records[0].productIds.object=true&orders[0].productNames=&hitCount=true&productIds.object=true&records[0].productIds._nodeFactory._cfgBigDecimalExact=true&total=0&isSearchCount=true&orders[0].productTypeId=0&records[0].name=&orders[0].productIds.valueNode=true&records[0].productIds.containerNode=true&records[0].signalNum=0&productIds.containerNode=true&records[0].productIds.array=true&orders[0].signalNum=0&orders[0].productIds.array=true&records[0].productIds.valueNode=true&productIds._nodeFactory._cfgBigDecimalExact=true&productIds.array=true&records[0].productId=0&name=&records[0].productIds.missingNode=true&productIds.valueNode=true&orders[0].id=0&orders[0].signalId=0&maxLimit=0&records[0].id=0&optimizeCountSql=true'2.23.2. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | 记录id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─name | string | 组名称 | - |
└─signalNum | int32 | 点位数量 | - |
└─signalId | int64 | 点位id | - |
└─productIds | object | 产品id列表 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─_children | array | No comments found. | - |
└─productNames | string | No comments found. | - |
└─signalIds | array | 点位信号列表 | - |
└─productId | int64 | No comments found. | - |
└─productTypeId | int64 | No comments found. | - |
└─createTime | string | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"name": "",
"signalNum": 0,
"signalId": 0,
"productIds": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
},
"_children": [
{
"object": "any object"
}
]
},
"productNames": "",
"signalIds": [
""
],
"productId": 0,
"productTypeId": 0,
"createTime": "yyyy-MM-dd HH:mm:ss"
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/pointGroup/edit?id=0&=kj70xs'2.23.3. 新增或者更新记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
name | string | false | 组名称 |
signalNum | int32 | false | 点位数量 |
signalId | int64 | false | 点位id |
productIds | object | false | 产品id列表 |
└─array | boolean | false | No comments found. |
└─object | boolean | false | No comments found. |
└─containerNode | boolean | false | No comments found. |
└─valueNode | boolean | false | No comments found. |
└─missingNode | boolean | false | No comments found. |
└─_nodeFactory | object | false | No comments found. |
└─_cfgBigDecimalExact | boolean | false | No comments found. |
└─_children | array | false | No comments found. |
productNames | string | false | No comments found. |
signalIds | array | false | 点位信号列表 |
productId | int64 | false | No comments found. |
productTypeId | int64 | false | No comments found. |
createTime | string | false | No comments found. |
Request-body:
{
"id": 0,
"name": "",
"signalNum": 0,
"signalId": 0,
"productIds": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
},
"_children": [
{
"object": "any object"
}
]
},
"productNames": "",
"signalIds": [
""
],
"productId": 0,
"productTypeId": 0,
"createTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/pointGroup/saveOrUpdate' --data '{
"id": 0,
"name": "",
"signalNum": 0,
"signalId": 0,
"productIds": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
},
"_children": [
{
"object": "any object"
}
]
},
"productNames": "",
"signalIds": [
""
],
"productId": 0,
"productTypeId": 0,
"createTime": "yyyy-MM-dd HH:mm:ss"
}'2.23.4. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/pointGroup/del' --data '[
0
]'2.23.5. 获取点位组列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取点位组列表
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─name | string | 组名称 | - |
└─signalNum | int32 | 点位数量 | - |
└─signalId | int64 | 点位id | - |
└─productIds | object | 产品id列表 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─_children | array | No comments found. | - |
└─productNames | string | No comments found. | - |
└─signalIds | array | 点位信号列表 | - |
└─productId | int64 | No comments found. | - |
└─productTypeId | int64 | No comments found. | - |
└─createTime | string | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"name": "",
"signalNum": 0,
"signalId": 0,
"productIds": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
},
"_children": [
{
"object": "any object"
}
]
},
"productNames": "",
"signalIds": [
""
],
"productId": 0,
"productTypeId": 0,
"createTime": "yyyy-MM-dd HH:mm:ss"
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/pointGroup/list'2.24. 产品管理
2.24.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
logo | string | false | 图标 | ||
status | enum | false | 产品状态 | ||
code | string | true | 产品代码 | ||
deviceType | enum | true | 设备类型 | ||
productTypeId | int64 | true | 产品类型 | ||
typeName | string | false | 类型名称 | ||
name | string | true | 产品名称 | ||
parentId | int64 | false | 父产品id | ||
gatewayId | int64 | true | 绑定的网关 | ||
protocolId | int64 | true | 绑定的协议 | ||
config | object | false | 产品配置 | ||
└─map | map | false | No comments found. | ||
└─any object | object | false | any object. | ||
remark | string | false | 产品说明 | ||
createTime | string | false | 创建时间 | ||
gatewayType | enum | false | 网关类型 | ||
gatewayName | string | false | 网关名称 | ||
protocolName | string | false | 协议名称 | ||
protocolCode | string | false | 协议代码 | ||
connectType | enum | false | 网关连接类型 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─logo | string | 图标 | - |
└─status | enum | 产品状态 | - |
└─code | string | 产品代码 | - |
└─deviceType | enum | 设备类型 | - |
└─productTypeId | int64 | 产品类型 | - |
└─typeName | string | 类型名称 | - |
└─name | string | 产品名称 | - |
└─parentId | int64 | 父产品id | - |
└─gatewayId | int64 | 绑定的网关 | - |
└─protocolId | int64 | 绑定的协议 | - |
└─config | object | 产品配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─remark | string | 产品说明 | - |
└─createTime | string | 创建时间 | - |
└─gatewayType | enum | 网关类型 | - |
└─gatewayName | string | 网关名称 | - |
└─protocolName | string | 协议名称 | - |
└─protocolCode | string | 协议代码 | - |
└─connectType | enum | 网关连接类型 | - |
└─deviceCount | int32 | 设备数量 | - |
└─ctrlMode | enum | 操作类型 | - |
└─gatewayStatus | enum | 网关状态 | - |
└─transportProtocol | enum | 传输协议 | - |
└─attrs | array | 物模型属性 | - |
└─id | int64 | No comments found. | - |
└─productId | int64 | 所属产品 | - |
└─field | string | 属性代码 | - |
└─name | string | 属性名称 | - |
└─dataType | string | 数据类型 | - |
└─realType | string | 实际类型 | - |
└─attrType | enum | 读写方式 | - |
└─enumerate | boolean | 是否枚举 | - |
└─defaultValue | string | 默认值 | - |
└─unit | string | 单位 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─remark | string | 描述 | - |
└─origin | enum | 属性来源 | - |
└─ctrlStatus | boolean | 是否属于控制状态 | - |
└─createTime | string | 创建时间 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─funcApis | array | 物模型功能接口 | - |
└─id | int64 | No comments found. | - |
└─type | enum | 接口类型 | - |
└─direct | string | 协议指令 | - |
└─code | string | 功能代码 | - |
└─debug | boolean | 显示到调试 | - |
└─protocol | boolean | 是否为协议接口 | - |
└─productId | int64 | 所属产品 | - |
└─name | string | 接口名称 | - |
└─status | string | 接口状态 | - |
└─remark | string | 接口说明 | - |
└─asStatus | boolean | 作为状态位(用于点位控制协议) | - |
└─createTime | string | 创建时间 | - |
└─funcType | enum | 功能类型 | - |
└─productCode | string | No comments found. | - |
└─triggerMode | enum | 事件触发方式 | - |
└─directParams | object | 指令参数 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─_children | map | No comments found. | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─upConfig | array | 上行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─downConfig | array | 下行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─eventApis | array | 物模型事件接口 | - |
└─id | int64 | No comments found. | - |
└─type | enum | 接口类型 | - |
└─direct | string | 协议指令 | - |
└─code | string | 功能代码 | - |
└─debug | boolean | 显示到调试 | - |
└─protocol | boolean | 是否为协议接口 | - |
└─productId | int64 | 所属产品 | - |
└─name | string | 接口名称 | - |
└─status | string | 接口状态 | - |
└─remark | string | 接口说明 | - |
└─asStatus | boolean | 作为状态位(用于点位控制协议) | - |
└─createTime | string | 创建时间 | - |
└─funcType | enum | 功能类型 | - |
└─productCode | string | No comments found. | - |
└─triggerMode | enum | 事件触发方式 | - |
└─directParams | object | 指令参数 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─_children | map | No comments found. | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─upConfig | array | 上行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─downConfig | array | 下行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"logo": "",
"status": "enabled",
"code": "",
"deviceType": "Direct",
"productTypeId": 0,
"typeName": "",
"name": "",
"parentId": 0,
"gatewayId": 0,
"protocolId": 0,
"config": {
"map": {
"mapKey": {}
}
},
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"gatewayType": "Direct",
"gatewayName": "",
"protocolName": "",
"protocolCode": "",
"connectType": "Client",
"deviceCount": 0,
"ctrlMode": "COMMON",
"gatewayStatus": "stop",
"transportProtocol": "TCP",
"attrs": [
{
"id": 0,
"productId": 0,
"field": "",
"name": "",
"dataType": "",
"realType": "",
"attrType": "R",
"enumerate": true,
"defaultValue": "",
"unit": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"remark": "",
"origin": "Protocol",
"ctrlStatus": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
],
"funcApis": [
{
"id": 0,
"type": "func",
"direct": "",
"code": "",
"debug": true,
"protocol": true,
"productId": 0,
"name": "",
"status": "",
"remark": "",
"asStatus": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"funcType": "R",
"productCode": "",
"triggerMode": "active",
"directParams": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
},
"_children": {
"mapKey": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true
}
}
},
"upConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
],
"downConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
]
}
],
"eventApis": [
{
"id": 0,
"type": "func",
"direct": "",
"code": "",
"debug": true,
"protocol": true,
"productId": 0,
"name": "",
"status": "",
"remark": "",
"asStatus": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"funcType": "R",
"productCode": "",
"triggerMode": "active",
"directParams": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
},
"_children": {
"mapKey": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true
}
}
},
"upConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
],
"downConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
]
}
]
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/product/view?size=0¤t=0&id=0&status=enabled&deviceType=Direct&productTypeId=0&parentId=0&gatewayId=0&protocolId=0&createTime=yyyy-MM-dd HH:mm:ss&gatewayType=Direct&connectType=Client&orders[0].protocolId=0&records[0].status=enabled&remark=&orders[0].gatewayName=&orders[0].status=enabled&pages=0&orders[0].name=&records[0].id=0&hitCount=true&typeName=&records[0].protocolCode=&records[0].gatewayId=0&records[0].createTime=yyyy-MM-dd HH:mm:ss&records[0].protocolId=0&logo=&orders[0].protocolName=&records[0].logo=&name=&records[0].protocolName=&orders[0].typeName=&protocolName=&total=0&orders[0].gatewayType=Direct&orders[0].connectType=Client&code=&records[0].parentId=0&records[0].productTypeId=0&orders[0].gatewayId=0&countId=&orders[0].code=&orders[0].createTime=yyyy-MM-dd HH:mm:ss&orders[0].id=0&orders[0].productTypeId=0&optimizeCountSql=true&orders[0].parentId=0&orders[0].deviceType=Direct&records[0].gatewayType=Direct&maxLimit=0&isSearchCount=true&records[0].gatewayName=&records[0].remark=&orders[0].protocolCode=&records[0].typeName=&gatewayName=&protocolCode=&records[0].deviceType=Direct&records[0].code=&records[0].connectType=Client&orders[0].logo=&records[0].name=&orders[0].remark='2.24.2. 返回产品列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 返回产品列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. | ||
logo | string | false | 图标 | ||
status | enum | false | 产品状态 | ||
code | string | true | 产品代码 | ||
deviceType | enum | true | 设备类型 | ||
productTypeId | int64 | true | 产品类型 | ||
typeName | string | false | 类型名称 | ||
name | string | true | 产品名称 | ||
parentId | int64 | false | 父产品id | ||
gatewayId | int64 | true | 绑定的网关 | ||
protocolId | int64 | true | 绑定的协议 | ||
config | object | false | 产品配置 | ||
└─map | map | false | No comments found. | ||
└─any object | object | false | any object. | ||
remark | string | false | 产品说明 | ||
createTime | string | false | 创建时间 | ||
gatewayType | enum | false | 网关类型 | ||
gatewayName | string | false | 网关名称 | ||
protocolName | string | false | 协议名称 | ||
protocolCode | string | false | 协议代码 | ||
connectType | enum | false | 网关连接类型 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─disabled | boolean | 是否禁用 | - |
└─checked | boolean | 是否默认选中 | - |
└─children | array | 子项 | - |
└─extra | object | 额外扩展信息 | - |
└─selectable | boolean | 可选中 | - |
└─checkable | boolean | 复选框是否能被选中 | - |
└─config | map | 配置项 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"label": "",
"value": {
"object": "any object"
},
"disabled": true,
"checked": true,
"children": [
{
"$ref": ".."
}
],
"extra": {
"object": "any object"
},
"selectable": true,
"checkable": true,
"config": {
"mapKey": {}
}
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/product/list?id=0&status=enabled&deviceType=Direct&productTypeId=0&parentId=0&gatewayId=0&protocolId=0&createTime=yyyy-MM-dd HH:mm:ss&gatewayType=Direct&connectType=Client&logo=&remark=&gatewayName=&code=&protocolName=&typeName=&protocolCode=&name='2.24.3. 获取指定类型下面的列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取指定类型下面的列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
productTypeId | int64 | false | -1将获取所有 | ||
deviceType | enum | false | Direct(设备直连) | ||
gatewayId | int64 | false | 网关id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─logo | string | 图标 | - |
└─status | enum | 产品状态 | - |
└─code | string | 产品代码 | - |
└─deviceType | enum | 设备类型 | - |
└─productTypeId | int64 | 产品类型 | - |
└─typeName | string | 类型名称 | - |
└─name | string | 产品名称 | - |
└─parentId | int64 | 父产品id | - |
└─gatewayId | int64 | 绑定的网关 | - |
└─protocolId | int64 | 绑定的协议 | - |
└─config | object | 产品配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─remark | string | 产品说明 | - |
└─createTime | string | 创建时间 | - |
└─gatewayType | enum | 网关类型 | - |
└─gatewayName | string | 网关名称 | - |
└─protocolName | string | 协议名称 | - |
└─protocolCode | string | 协议代码 | - |
└─connectType | enum | 网关连接类型 | - |
└─deviceCount | int32 | 设备数量 | - |
└─ctrlMode | enum | 操作类型 | - |
└─gatewayStatus | enum | 网关状态 | - |
└─transportProtocol | enum | 传输协议 | - |
└─attrs | array | 物模型属性 | - |
└─id | int64 | No comments found. | - |
└─productId | int64 | 所属产品 | - |
└─field | string | 属性代码 | - |
└─name | string | 属性名称 | - |
└─dataType | string | 数据类型 | - |
└─realType | string | 实际类型 | - |
└─attrType | enum | 读写方式 | - |
└─enumerate | boolean | 是否枚举 | - |
└─defaultValue | string | 默认值 | - |
└─unit | string | 单位 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─remark | string | 描述 | - |
└─origin | enum | 属性来源 | - |
└─ctrlStatus | boolean | 是否属于控制状态 | - |
└─createTime | string | 创建时间 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─funcApis | array | 物模型功能接口 | - |
└─id | int64 | No comments found. | - |
└─type | enum | 接口类型 | - |
└─direct | string | 协议指令 | - |
└─code | string | 功能代码 | - |
└─debug | boolean | 显示到调试 | - |
└─protocol | boolean | 是否为协议接口 | - |
└─productId | int64 | 所属产品 | - |
└─name | string | 接口名称 | - |
└─status | string | 接口状态 | - |
└─remark | string | 接口说明 | - |
└─asStatus | boolean | 作为状态位(用于点位控制协议) | - |
└─createTime | string | 创建时间 | - |
└─funcType | enum | 功能类型 | - |
└─productCode | string | No comments found. | - |
└─triggerMode | enum | 事件触发方式 | - |
└─directParams | object | 指令参数 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─_children | map | No comments found. | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─upConfig | array | 上行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─downConfig | array | 下行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─eventApis | array | 物模型事件接口 | - |
└─id | int64 | No comments found. | - |
└─type | enum | 接口类型 | - |
└─direct | string | 协议指令 | - |
└─code | string | 功能代码 | - |
└─debug | boolean | 显示到调试 | - |
└─protocol | boolean | 是否为协议接口 | - |
└─productId | int64 | 所属产品 | - |
└─name | string | 接口名称 | - |
└─status | string | 接口状态 | - |
└─remark | string | 接口说明 | - |
└─asStatus | boolean | 作为状态位(用于点位控制协议) | - |
└─createTime | string | 创建时间 | - |
└─funcType | enum | 功能类型 | - |
└─productCode | string | No comments found. | - |
└─triggerMode | enum | 事件触发方式 | - |
└─directParams | object | 指令参数 | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─_nodeFactory | object | No comments found. | - |
└─_cfgBigDecimalExact | boolean | No comments found. | - |
└─_children | map | No comments found. | - |
└─array | boolean | No comments found. | - |
└─object | boolean | No comments found. | - |
└─containerNode | boolean | No comments found. | - |
└─valueNode | boolean | No comments found. | - |
└─missingNode | boolean | No comments found. | - |
└─upConfig | array | 上行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─downConfig | array | 下行接口配置 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─apiCode | string | 接口码 | - |
└─attrField | string | 物模型属性字段 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─productId | int64 | 所属产品 | - |
└─remark | string | 备注 | - |
└─value | string | 配置值 | - |
└─modelAttrId | int64 | 模型属性id | - |
└─fieldType | enum | 字段类型 | - |
└─protocolDataType | string | 协议属性类型 | - |
└─protocolAttrField | string | 协议属性字段 | - |
└─protocolAttrName | string | 协议属性名称 | - |
└─createTime | string | 创建时间 | - |
└─direction | enum | 接口方向 | - |
└─accuracy | int32 | 精度 | - |
└─funcType | enum | 属性读写类型 | - |
└─attrDefaultValue | string | 属性默认值 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─dicts | array | 属性字典列表 | - |
└─id | int64 | No comments found. | - |
└─path | string | 路径 | - |
└─dictName | string | 字典名称 | - |
└─dictValue | string | 字典值 | - |
└─dataType | string | 数据类型 | - |
└─attrField | string | 属性字段 | - |
└─accuracy | int32 | 精度 | - |
└─gain | int32 | 数据增益 | - |
└─resolver | string | 数据解析器 | - |
└─script | string | 自定义解析脚本 | - |
└─modelAttrId | int64 | 模型属性id | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"logo": "",
"status": "enabled",
"code": "",
"deviceType": "Direct",
"productTypeId": 0,
"typeName": "",
"name": "",
"parentId": 0,
"gatewayId": 0,
"protocolId": 0,
"config": {
"map": {
"mapKey": {}
}
},
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"gatewayType": "Direct",
"gatewayName": "",
"protocolName": "",
"protocolCode": "",
"connectType": "Client",
"deviceCount": 0,
"ctrlMode": "COMMON",
"gatewayStatus": "stop",
"transportProtocol": "TCP",
"attrs": [
{
"id": 0,
"productId": 0,
"field": "",
"name": "",
"dataType": "",
"realType": "",
"attrType": "R",
"enumerate": true,
"defaultValue": "",
"unit": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"remark": "",
"origin": "Protocol",
"ctrlStatus": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
],
"funcApis": [
{
"id": 0,
"type": "func",
"direct": "",
"code": "",
"debug": true,
"protocol": true,
"productId": 0,
"name": "",
"status": "",
"remark": "",
"asStatus": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"funcType": "R",
"productCode": "",
"triggerMode": "active",
"directParams": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
},
"_children": {
"mapKey": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true
}
}
},
"upConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
],
"downConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
]
}
],
"eventApis": [
{
"id": 0,
"type": "func",
"direct": "",
"code": "",
"debug": true,
"protocol": true,
"productId": 0,
"name": "",
"status": "",
"remark": "",
"asStatus": true,
"createTime": "yyyy-MM-dd HH:mm:ss",
"funcType": "R",
"productCode": "",
"triggerMode": "active",
"directParams": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true,
"_nodeFactory": {
"_cfgBigDecimalExact": true
},
"_children": {
"mapKey": {
"array": true,
"object": true,
"containerNode": true,
"valueNode": true,
"missingNode": true
}
}
},
"upConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
],
"downConfig": [
{
"id": 0,
"sort": 0,
"apiCode": "",
"attrField": "",
"attrName": "",
"dataType": "",
"productId": 0,
"remark": "",
"value": "",
"modelAttrId": 0,
"fieldType": "status",
"protocolDataType": "",
"protocolAttrField": "",
"protocolAttrName": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"direction": "UP",
"accuracy": 0,
"funcType": "R",
"attrDefaultValue": "",
"gain": 0,
"resolver": "",
"script": "",
"dicts": [
{
"id": 0,
"path": "",
"dictName": "",
"dictValue": "",
"dataType": "",
"attrField": "",
"accuracy": 0,
"gain": 0,
"resolver": "",
"script": "",
"modelAttrId": 0
}
]
}
]
}
]
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/product/listByType?productTypeId=0&deviceType=Direct&gatewayId=0&=fiv7i5'2.24.4. 父产品列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 父产品列表
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─logo | string | 图标 | - |
└─status | enum | 产品状态 | - |
└─code | string | 产品代码 | - |
└─deviceType | enum | 设备类型 | - |
└─productTypeId | int64 | 产品类型 | - |
└─typeName | string | 类型名称 | - |
└─name | string | 产品名称 | - |
└─parentId | int64 | 父产品id | - |
└─gatewayId | int64 | 绑定的网关 | - |
└─protocolId | int64 | 绑定的协议 | - |
└─config | object | 产品配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─remark | string | 产品说明 | - |
└─createTime | string | 创建时间 | - |
└─gatewayType | enum | 网关类型 | - |
└─gatewayName | string | 网关名称 | - |
└─protocolName | string | 协议名称 | - |
└─protocolCode | string | 协议代码 | - |
└─connectType | enum | 网关连接类型 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"logo": "",
"status": "enabled",
"code": "",
"deviceType": "Direct",
"productTypeId": 0,
"typeName": "",
"name": "",
"parentId": 0,
"gatewayId": 0,
"protocolId": 0,
"config": {
"map": {
"mapKey": {}
}
},
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"gatewayType": "Direct",
"gatewayName": "",
"protocolName": "",
"protocolCode": "",
"connectType": "Client"
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/product/parent'2.24.5. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | 记录id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─logo | string | 图标 | - |
└─status | enum | 产品状态 | - |
└─code | string | 产品代码 | - |
└─deviceType | enum | 设备类型 | - |
└─productTypeId | int64 | 产品类型 | - |
└─typeName | string | 类型名称 | - |
└─name | string | 产品名称 | - |
└─parentId | int64 | 父产品id | - |
└─gatewayId | int64 | 绑定的网关 | - |
└─protocolId | int64 | 绑定的协议 | - |
└─config | object | 产品配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─remark | string | 产品说明 | - |
└─createTime | string | 创建时间 | - |
└─gatewayType | enum | 网关类型 | - |
└─gatewayName | string | 网关名称 | - |
└─protocolName | string | 协议名称 | - |
└─protocolCode | string | 协议代码 | - |
└─connectType | enum | 网关连接类型 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"logo": "",
"status": "enabled",
"code": "",
"deviceType": "Direct",
"productTypeId": 0,
"typeName": "",
"name": "",
"parentId": 0,
"gatewayId": 0,
"protocolId": 0,
"config": {
"map": {
"mapKey": {}
}
},
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"gatewayType": "Direct",
"gatewayName": "",
"protocolName": "",
"protocolCode": "",
"connectType": "Client"
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/product/edit?id=0&=zzfv1p'2.24.6. 新增或者更新记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
logo | string | false | 图标 |
status | enum | false | 产品状态 |
code | string | true | 产品代码 |
deviceType | enum | true | 设备类型 |
productTypeId | int64 | true | 产品类型 |
typeName | string | false | 类型名称 |
name | string | true | 产品名称 |
parentId | int64 | false | 父产品id |
gatewayId | int64 | true | 绑定的网关 |
protocolId | int64 | true | 绑定的协议 |
config | object | false | 产品配置 |
└─map | map | false | No comments found. |
└─any object | object | false | any object. |
remark | string | false | 产品说明 |
createTime | string | false | 创建时间 |
gatewayType | enum | false | 网关类型 |
gatewayName | string | false | 网关名称 |
protocolName | string | false | 协议名称 |
protocolCode | string | false | 协议代码 |
connectType | enum | false | 网关连接类型 |
Request-body:
{
"id": 0,
"logo": "",
"status": "enabled",
"code": "",
"deviceType": "Direct",
"productTypeId": 0,
"typeName": "",
"name": "",
"parentId": 0,
"gatewayId": 0,
"protocolId": 0,
"config": {
"map": {
"mapKey": {}
}
},
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"gatewayType": "Direct",
"gatewayName": "",
"protocolName": "",
"protocolCode": "",
"connectType": "Client"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/product/saveOrUpdate' --data '{
"id": 0,
"logo": "",
"status": "enabled",
"code": "",
"deviceType": "Direct",
"productTypeId": 0,
"typeName": "",
"name": "",
"parentId": 0,
"gatewayId": 0,
"protocolId": 0,
"config": {
"map": {
"mapKey": {}
}
},
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"gatewayType": "Direct",
"gatewayName": "",
"protocolName": "",
"protocolCode": "",
"connectType": "Client"
}'2.24.7. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/product/del' --data '[
0
]'2.24.8. 设备类型列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 设备类型列表
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─disabled | boolean | 是否禁用 | - |
└─checked | boolean | 是否默认选中 | - |
└─children | array | 子项 | - |
└─extra | object | 额外扩展信息 | - |
└─selectable | boolean | 可选中 | - |
└─checkable | boolean | 复选框是否能被选中 | - |
└─config | map | 配置项 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"label": "",
"value": {
"object": "any object"
},
"disabled": true,
"checked": true,
"children": [
{
"$ref": ".."
}
],
"extra": {
"object": "any object"
},
"selectable": true,
"checkable": true,
"config": {
"mapKey": {}
}
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/product/deviceTypes'2.24.9. 切换产品状态
Type: POST
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 切换产品状态
Path-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | true | 产品id | ||
status | enum | true | enabled(启用) |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -i 'http://127.0.0.1:8085/api/iot/product/switch/{id}/{status}'2.24.10. 获取点位协议的产品列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取点位协议的产品列表
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─logo | string | 图标 | - |
└─status | enum | 产品状态 | - |
└─code | string | 产品代码 | - |
└─deviceType | enum | 设备类型 | - |
└─productTypeId | int64 | 产品类型 | - |
└─typeName | string | 类型名称 | - |
└─name | string | 产品名称 | - |
└─parentId | int64 | 父产品id | - |
└─gatewayId | int64 | 绑定的网关 | - |
└─protocolId | int64 | 绑定的协议 | - |
└─config | object | 产品配置 | - |
└─map | map | No comments found. | - |
└─any object | object | any object. | - |
└─remark | string | 产品说明 | - |
└─createTime | string | 创建时间 | - |
└─gatewayType | enum | 网关类型 | - |
└─gatewayName | string | 网关名称 | - |
└─protocolName | string | 协议名称 | - |
└─protocolCode | string | 协议代码 | - |
└─connectType | enum | 网关连接类型 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"logo": "",
"status": "enabled",
"code": "",
"deviceType": "Direct",
"productTypeId": 0,
"typeName": "",
"name": "",
"parentId": 0,
"gatewayId": 0,
"protocolId": 0,
"config": {
"map": {
"mapKey": {}
}
},
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"gatewayType": "Direct",
"gatewayName": "",
"protocolName": "",
"protocolCode": "",
"connectType": "Client"
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/product/listByPoint'2.24.11. 解析器列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 解析器列表
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─disabled | boolean | 是否禁用 | - |
└─checked | boolean | 是否默认选中 | - |
└─children | array | 子项 | - |
└─extra | object | 额外扩展信息 | - |
└─selectable | boolean | 可选中 | - |
└─checkable | boolean | 复选框是否能被选中 | - |
└─config | map | 配置项 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"label": "",
"value": {
"object": "any object"
},
"disabled": true,
"checked": true,
"children": [
{
"$ref": ".."
}
],
"extra": {
"object": "any object"
},
"selectable": true,
"checkable": true,
"config": {
"mapKey": {}
}
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/product/resolvers'2.25. 产品类型管理
2.25.1. 分页列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 分页列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
children | array | false | 此节点的子节点 | ||
pid | int64 | false | 父节点 | ||
path | string | false | 路径 | ||
name | string | false | 类型名称 | ||
parentName | string | false | 父类型名称 | ||
alias | string | false | 类型别名 | ||
remark | string | false | 类型说明 | ||
createTime | string | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─children | array | 此节点的子节点 | - |
└─pid | int64 | 父节点 | - |
└─path | string | 路径 | - |
└─name | string | 类型名称 | - |
└─parentName | string | 父类型名称 | - |
└─alias | string | 类型别名 | - |
└─remark | string | 类型说明 | - |
└─createTime | string | No comments found. | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"path": "",
"name": "",
"parentName": "",
"alias": "",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss"
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/productType/view?size=0¤t=0&id=0&pid=0&createTime=yyyy-MM-dd HH:mm:ss&records[0].remark=&path=&records[0].alias=&records[0].createTime=yyyy-MM-dd HH:mm:ss&orders[0].parentName=&records[0].path=&records[0].name=&records[0].parentName=&pages=0&orders[0].id=0&maxLimit=0&remark=&orders[0].createTime=yyyy-MM-dd HH:mm:ss&orders[0].path=&total=0&isSearchCount=true&name=&orders[0].remark=&orders[0].pid=0&orders[0].alias=&records[0].id=0&optimizeCountSql=true&hitCount=true&records[0].pid=0&countId=&alias=&orders[0].name=&parentName='2.25.2. 树结构列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 树结构列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. | ||
children | array | false | 此节点的子节点 | ||
pid | int64 | false | 父节点 | ||
path | string | false | 路径 | ||
name | string | false | 类型名称 | ||
parentName | string | false | 父类型名称 | ||
alias | string | false | 类型别名 | ||
remark | string | false | 类型说明 | ||
createTime | string | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─children | array | 此节点的子节点 | - |
└─pid | int64 | 父节点 | - |
└─path | string | 路径 | - |
└─name | string | 类型名称 | - |
└─parentName | string | 父类型名称 | - |
└─alias | string | 类型别名 | - |
└─remark | string | 类型说明 | - |
└─createTime | string | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"path": "",
"name": "",
"parentName": "",
"alias": "",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss"
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/productType/tree?id=0&pid=0&createTime=yyyy-MM-dd HH:mm:ss&remark=&path=&alias=&name=&parentName='2.25.3. 产品类型-产品树
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 产品类型-产品树
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
select | string | false | 可选类型(productType,product) null都可选择 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | 产品、产品类型id | - |
└─pid | int64 | 父级id | - |
└─type | string | 树节点类型 | - |
└─key | string | 唯一key | - |
└─pkey | string | 父级key | - |
└─name | string | 名称 | - |
└─isLeaf | boolean | 是否叶子节点 | - |
└─disabled | boolean | 是否禁用 | - |
└─children | array | 子数据 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"pid": 0,
"type": "",
"key": "",
"pkey": "",
"name": "",
"isLeaf": true,
"disabled": true,
"children": [
{
"$ref": ".."
}
]
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/productType/productTree?=mry4u8'2.25.4. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | 记录id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─children | array | 此节点的子节点 | - |
└─pid | int64 | 父节点 | - |
└─path | string | 路径 | - |
└─name | string | 类型名称 | - |
└─parentName | string | 父类型名称 | - |
└─alias | string | 类型别名 | - |
└─remark | string | 类型说明 | - |
└─createTime | string | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"path": "",
"name": "",
"parentName": "",
"alias": "",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss"
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/productType/edit?id=0&=i0ltlf'2.25.5. 修改记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 修改记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
children | array | false | 此节点的子节点 |
pid | int64 | false | 父节点 |
path | string | false | 路径 |
name | string | false | 类型名称 |
parentName | string | false | 父类型名称 |
alias | string | false | 类型别名 |
remark | string | false | 类型说明 |
createTime | string | false | No comments found. |
Request-body:
{
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"path": "",
"name": "",
"parentName": "",
"alias": "",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/productType/edit' --data '{
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"path": "",
"name": "",
"parentName": "",
"alias": "",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss"
}'2.25.6. 新增记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
children | array | false | 此节点的子节点 |
pid | int64 | false | 父节点 |
path | string | false | 路径 |
name | string | false | 类型名称 |
parentName | string | false | 父类型名称 |
alias | string | false | 类型别名 |
remark | string | false | 类型说明 |
createTime | string | false | No comments found. |
Request-body:
{
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"path": "",
"name": "",
"parentName": "",
"alias": "",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/productType/add' --data '{
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"path": "",
"name": "",
"parentName": "",
"alias": "",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss"
}'2.25.7. 新增或者修改
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增或者修改
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
children | array | false | 此节点的子节点 |
pid | int64 | false | 父节点 |
path | string | false | 路径 |
name | string | false | 类型名称 |
parentName | string | false | 父类型名称 |
alias | string | false | 类型别名 |
remark | string | false | 类型说明 |
createTime | string | false | No comments found. |
Request-body:
{
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"path": "",
"name": "",
"parentName": "",
"alias": "",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/productType/saveOrUpdate' --data '{
"id": 0,
"children": [
{
"object": "any object"
}
],
"pid": 0,
"path": "",
"name": "",
"parentName": "",
"alias": "",
"remark": "",
"createTime": "yyyy-MM-dd HH:mm:ss"
}'2.25.8. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/productType/del' --data '[
0
]'2.25.9. 获取设备类型别名列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取设备类型别名列表
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─label | string | 名称 | - |
└─value | string | 值 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"label": "",
"value": ""
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/productType/alias'2.26. 协议接口配置管理
2.26.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
sort | int32 | false | 排序 | ||
protocolApiCode | string | false | 所属api接口 | ||
protocolAttrField | string | false | 协议属性 | ||
remark | string | false | 备注 | ||
position | string | false | 点位地址 | ||
length | int32 | false | 配置长度 | ||
createTime | string | false | 创建时间 | ||
attrName | string | false | 属性名称 | ||
dataType | string | false | 属性类型 | ||
attrRemark | string | false | 属性说明 | ||
fieldType | enum | false | 字段类型 | ||
options | array | false | 下拉款配置项 | ||
└─label | string | false | 标签 | ||
└─value | object | false | 值 | ||
└─extra | object | false | 额外扩展信息 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─protocolApiCode | string | 所属api接口 | - |
└─protocolAttrField | string | 协议属性 | - |
└─remark | string | 备注 | - |
└─position | string | 点位地址 | - |
└─length | int32 | 配置长度 | - |
└─createTime | string | 创建时间 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─attrRemark | string | 属性说明 | - |
└─fieldType | enum | 字段类型 | - |
└─options | array | 下拉款配置项 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─extra | object | 额外扩展信息 | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"sort": 0,
"protocolApiCode": "",
"protocolAttrField": "",
"remark": "",
"position": "",
"length": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"attrName": "",
"dataType": "",
"attrRemark": "",
"fieldType": "status",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"extra": {
"object": "any object"
}
}
]
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/protocolApiConfig/view?size=0¤t=0&id=0&sort=0&length=0&createTime=yyyy-MM-dd HH:mm:ss&fieldType=status&records[0].sort=0&records[0].protocolApiCode=&records[0].options[0].label=&orders[0].position=&orders[0].remark=&records[0].remark=&orders[0].protocolApiCode=&hitCount=true&records[0].fieldType=status&maxLimit=0&isSearchCount=true&records[0].attrRemark=&records[0].length=0&orders[0].fieldType=status&optimizeCountSql=true&dataType=&position=&options[0].label=&attrName=&orders[0].sort=0&orders[0].protocolAttrField=&total=0&orders[0].dataType=&protocolAttrField=&records[0].id=0&records[0].createTime=yyyy-MM-dd HH:mm:ss&orders[0].attrRemark=&orders[0].attrName=&attrRemark=&orders[0].length=0&orders[0].createTime=yyyy-MM-dd HH:mm:ss&records[0].dataType=&orders[0].options[0].label=&records[0].attrName=&protocolApiCode=&orders[0].id=0&pages=0&remark=&records[0].protocolAttrField=&records[0].position=&countId='2.26.2. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | 记录id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─protocolApiCode | string | 所属api接口 | - |
└─protocolAttrField | string | 协议属性 | - |
└─remark | string | 备注 | - |
└─position | string | 点位地址 | - |
└─length | int32 | 配置长度 | - |
└─createTime | string | 创建时间 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─attrRemark | string | 属性说明 | - |
└─fieldType | enum | 字段类型 | - |
└─options | array | 下拉款配置项 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─extra | object | 额外扩展信息 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"sort": 0,
"protocolApiCode": "",
"protocolAttrField": "",
"remark": "",
"position": "",
"length": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"attrName": "",
"dataType": "",
"attrRemark": "",
"fieldType": "status",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"extra": {
"object": "any object"
}
}
]
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/protocolApiConfig/edit?id=0&=wton2u'2.26.3. 新增或者更新记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
sort | int32 | false | 排序 |
protocolApiCode | string | false | 所属api接口 |
protocolAttrField | string | false | 协议属性 |
remark | string | false | 备注 |
position | string | false | 点位地址 |
length | int32 | false | 配置长度 |
createTime | string | false | 创建时间 |
attrName | string | false | 属性名称 |
dataType | string | false | 属性类型 |
attrRemark | string | false | 属性说明 |
fieldType | enum | false | 字段类型 |
options | array | false | 下拉款配置项 |
└─label | string | false | 标签 |
└─value | object | false | 值 |
└─extra | object | false | 额外扩展信息 |
Request-body:
{
"id": 0,
"sort": 0,
"protocolApiCode": "",
"protocolAttrField": "",
"remark": "",
"position": "",
"length": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"attrName": "",
"dataType": "",
"attrRemark": "",
"fieldType": "status",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"extra": {
"object": "any object"
}
}
]
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/protocolApiConfig/saveOrUpdate' --data '{
"id": 0,
"sort": 0,
"protocolApiCode": "",
"protocolAttrField": "",
"remark": "",
"position": "",
"length": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"attrName": "",
"dataType": "",
"attrRemark": "",
"fieldType": "status",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"extra": {
"object": "any object"
}
}
]
}'2.26.4. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/protocolApiConfig/del' --data '[
0
]'2.27. 协议接口管理
2.27.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
type | enum | false | 接口类型 | ||
triggerMode | enum | false | 事件触发方式 | ||
code | string | false | 接口代码 | ||
name | string | false | 接口名称 | ||
status | string | false | 接口状态 | ||
remark | string | false | 接口说明 | ||
funcType | enum | false | 功能类型 | ||
createTime | string | false | 创建时间 | ||
protocolCode | string | false | 所属协议 | ||
upConfigs | array | false | 接口上行配置列表 | ||
└─id | int64 | false | No comments found. | ||
└─sort | int32 | false | 排序 | ||
└─protocolApiCode | string | false | 所属api接口 | ||
└─protocolAttrField | string | false | 协议属性 | ||
└─remark | string | false | 备注 | ||
└─position | string | false | 点位地址 | ||
└─length | int32 | false | 配置长度 | ||
└─createTime | string | false | 创建时间 | ||
└─attrName | string | false | 属性名称 | ||
└─dataType | string | false | 属性类型 | ||
└─attrRemark | string | false | 属性说明 | ||
└─fieldType | enum | false | 字段类型 | ||
└─options | array | false | 下拉款配置项 | ||
└─label | string | false | 标签 | ||
└─value | object | false | 值 | ||
└─extra | object | false | 额外扩展信息 | ||
downConfigs | array | false | 接口下行配置列表 | ||
└─id | int64 | false | No comments found. | ||
└─sort | int32 | false | 排序 | ||
└─protocolApiCode | string | false | 所属api接口 | ||
└─protocolAttrField | string | false | 协议属性 | ||
└─remark | string | false | 备注 | ||
└─position | string | false | 点位地址 | ||
└─length | int32 | false | 配置长度 | ||
└─createTime | string | false | 创建时间 | ||
└─attrName | string | false | 属性名称 | ||
└─dataType | string | false | 属性类型 | ||
└─attrRemark | string | false | 属性说明 | ||
└─fieldType | enum | false | 字段类型 | ||
└─options | array | false | 下拉款配置项 | ||
└─label | string | false | 标签 | ||
└─value | object | false | 值 | ||
└─extra | object | false | 额外扩展信息 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─type | enum | 接口类型 | - |
└─triggerMode | enum | 事件触发方式 | - |
└─code | string | 接口代码 | - |
└─name | string | 接口名称 | - |
└─status | string | 接口状态 | - |
└─remark | string | 接口说明 | - |
└─funcType | enum | 功能类型 | - |
└─createTime | string | 创建时间 | - |
└─protocolCode | string | 所属协议 | - |
└─upConfigs | array | 接口上行配置列表 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─protocolApiCode | string | 所属api接口 | - |
└─protocolAttrField | string | 协议属性 | - |
└─remark | string | 备注 | - |
└─position | string | 点位地址 | - |
└─length | int32 | 配置长度 | - |
└─createTime | string | 创建时间 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─attrRemark | string | 属性说明 | - |
└─fieldType | enum | 字段类型 | - |
└─options | array | 下拉款配置项 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─extra | object | 额外扩展信息 | - |
└─downConfigs | array | 接口下行配置列表 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─protocolApiCode | string | 所属api接口 | - |
└─protocolAttrField | string | 协议属性 | - |
└─remark | string | 备注 | - |
└─position | string | 点位地址 | - |
└─length | int32 | 配置长度 | - |
└─createTime | string | 创建时间 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─attrRemark | string | 属性说明 | - |
└─fieldType | enum | 字段类型 | - |
└─options | array | 下拉款配置项 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─extra | object | 额外扩展信息 | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"type": "func",
"triggerMode": "active",
"code": "",
"name": "",
"status": "",
"remark": "",
"funcType": "R",
"createTime": "yyyy-MM-dd HH:mm:ss",
"protocolCode": "",
"upConfigs": [
{
"id": 0,
"sort": 0,
"protocolApiCode": "",
"protocolAttrField": "",
"remark": "",
"position": "",
"length": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"attrName": "",
"dataType": "",
"attrRemark": "",
"fieldType": "status",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"extra": {
"object": "any object"
}
}
]
}
],
"downConfigs": [
{
"id": 0,
"sort": 0,
"protocolApiCode": "",
"protocolAttrField": "",
"remark": "",
"position": "",
"length": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"attrName": "",
"dataType": "",
"attrRemark": "",
"fieldType": "status",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"extra": {
"object": "any object"
}
}
]
}
]
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/protocolApi/view?size=0¤t=0&id=0&type=func&triggerMode=active&funcType=R&createTime=yyyy-MM-dd HH:mm:ss&sort=0&length=0&fieldType=status&downConfigs[0].options[0].label=&orders[0].upConfigs[0].fieldType=status&downConfigs[0].protocolApiCode=&upConfigs[0].remark=&records[0].upConfigs[0].length=0&records[0].upConfigs[0].fieldType=status&code=&records[0].upConfigs[0].id=0&records[0].downConfigs[0].createTime=yyyy-MM-dd HH:mm:ss&orders[0].upConfigs[0].sort=0&records[0].downConfigs[0].options[0].label=&records[0].downConfigs[0].sort=0&upConfigs[0].position=&records[0].funcType=R&upConfigs[0].options[0].label=&downConfigs[0].fieldType=status&downConfigs[0].protocolAttrField=&records[0].upConfigs[0].sort=0&records[0].downConfigs[0].id=0&records[0].downConfigs[0].remark=&records[0].status=&orders[0].downConfigs[0].length=0&downConfigs[0].attrRemark=&orders[0].downConfigs[0].attrRemark=&records[0].upConfigs[0].createTime=yyyy-MM-dd HH:mm:ss&orders[0].downConfigs[0].fieldType=status&name=&orders[0].type=func&countId=&records[0].upConfigs[0].protocolApiCode=&records[0].downConfigs[0].attrName=&orders[0].downConfigs[0].attrName=&upConfigs[0].attrName=&records[0].type=func&orders[0].downConfigs[0].protocolAttrField=&orders[0].upConfigs[0].protocolAttrField=&records[0].downConfigs[0].protocolApiCode=&orders[0].downConfigs[0].createTime=yyyy-MM-dd HH:mm:ss&upConfigs[0].length=0&records[0].upConfigs[0].options[0].label=&optimizeCountSql=true&records[0].downConfigs[0].position=&orders[0].downConfigs[0].remark=&orders[0].downConfigs[0].position=&upConfigs[0].protocolApiCode=&orders[0].downConfigs[0].sort=0&upConfigs[0].protocolAttrField=&records[0].triggerMode=active&upConfigs[0].fieldType=status&orders[0].status=&downConfigs[0].dataType=&maxLimit=0&records[0].upConfigs[0].dataType=&downConfigs[0].length=0&downConfigs[0].attrName=&orders[0].upConfigs[0].dataType=&records[0].downConfigs[0].dataType=&records[0].protocolCode=&records[0].downConfigs[0].length=0&orders[0].funcType=R&orders[0].upConfigs[0].attrRemark=&upConfigs[0].createTime=yyyy-MM-dd HH:mm:ss&records[0].remark=&orders[0].name=&downConfigs[0].remark=&pages=0&records[0].name=&upConfigs[0].dataType=&records[0].id=0&records[0].upConfigs[0].attrRemark=&total=0&downConfigs[0].position=&status=&remark=&orders[0].downConfigs[0].protocolApiCode=&records[0].downConfigs[0].protocolAttrField=&orders[0].code=&records[0].createTime=yyyy-MM-dd HH:mm:ss&orders[0].createTime=yyyy-MM-dd HH:mm:ss&upConfigs[0].attrRemark=&orders[0].id=0&orders[0].upConfigs[0].id=0&downConfigs[0].id=0&orders[0].upConfigs[0].length=0&isSearchCount=true&hitCount=true&orders[0].downConfigs[0].id=0&orders[0].downConfigs[0].options[0].label=&records[0].downConfigs[0].attrRemark=&downConfigs[0].sort=0&orders[0].upConfigs[0].attrName=&orders[0].upConfigs[0].position=&orders[0].upConfigs[0].protocolApiCode=&orders[0].upConfigs[0].remark=&orders[0].protocolCode=&upConfigs[0].sort=0&records[0].upConfigs[0].attrName=&orders[0].upConfigs[0].options[0].label=&orders[0].remark=&orders[0].downConfigs[0].dataType=&records[0].upConfigs[0].protocolAttrField=&records[0].upConfigs[0].remark=&downConfigs[0].createTime=yyyy-MM-dd HH:mm:ss&orders[0].triggerMode=active&orders[0].upConfigs[0].createTime=yyyy-MM-dd HH:mm:ss&upConfigs[0].id=0&protocolCode=&records[0].downConfigs[0].fieldType=status&records[0].code=&records[0].upConfigs[0].position='2.27.2. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | 记录id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─type | enum | 接口类型 | - |
└─triggerMode | enum | 事件触发方式 | - |
└─code | string | 接口代码 | - |
└─name | string | 接口名称 | - |
└─status | string | 接口状态 | - |
└─remark | string | 接口说明 | - |
└─funcType | enum | 功能类型 | - |
└─createTime | string | 创建时间 | - |
└─protocolCode | string | 所属协议 | - |
└─upConfigs | array | 接口上行配置列表 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─protocolApiCode | string | 所属api接口 | - |
└─protocolAttrField | string | 协议属性 | - |
└─remark | string | 备注 | - |
└─position | string | 点位地址 | - |
└─length | int32 | 配置长度 | - |
└─createTime | string | 创建时间 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─attrRemark | string | 属性说明 | - |
└─fieldType | enum | 字段类型 | - |
└─options | array | 下拉款配置项 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─extra | object | 额外扩展信息 | - |
└─downConfigs | array | 接口下行配置列表 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─protocolApiCode | string | 所属api接口 | - |
└─protocolAttrField | string | 协议属性 | - |
└─remark | string | 备注 | - |
└─position | string | 点位地址 | - |
└─length | int32 | 配置长度 | - |
└─createTime | string | 创建时间 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─attrRemark | string | 属性说明 | - |
└─fieldType | enum | 字段类型 | - |
└─options | array | 下拉款配置项 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─extra | object | 额外扩展信息 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"type": "func",
"triggerMode": "active",
"code": "",
"name": "",
"status": "",
"remark": "",
"funcType": "R",
"createTime": "yyyy-MM-dd HH:mm:ss",
"protocolCode": "",
"upConfigs": [
{
"id": 0,
"sort": 0,
"protocolApiCode": "",
"protocolAttrField": "",
"remark": "",
"position": "",
"length": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"attrName": "",
"dataType": "",
"attrRemark": "",
"fieldType": "status",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"extra": {
"object": "any object"
}
}
]
}
],
"downConfigs": [
{
"id": 0,
"sort": 0,
"protocolApiCode": "",
"protocolAttrField": "",
"remark": "",
"position": "",
"length": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"attrName": "",
"dataType": "",
"attrRemark": "",
"fieldType": "status",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"extra": {
"object": "any object"
}
}
]
}
]
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/protocolApi/edit?id=0&=iliv3d'2.27.3. 新增或者更新记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
type | enum | false | 接口类型 |
triggerMode | enum | false | 事件触发方式 |
code | string | false | 接口代码 |
name | string | false | 接口名称 |
status | string | false | 接口状态 |
remark | string | false | 接口说明 |
funcType | enum | false | 功能类型 |
createTime | string | false | 创建时间 |
protocolCode | string | false | 所属协议 |
upConfigs | array | false | 接口上行配置列表 |
└─id | int64 | false | No comments found. |
└─sort | int32 | false | 排序 |
└─protocolApiCode | string | false | 所属api接口 |
└─protocolAttrField | string | false | 协议属性 |
└─remark | string | false | 备注 |
└─position | string | false | 点位地址 |
└─length | int32 | false | 配置长度 |
└─createTime | string | false | 创建时间 |
└─attrName | string | false | 属性名称 |
└─dataType | string | false | 属性类型 |
└─attrRemark | string | false | 属性说明 |
└─fieldType | enum | false | 字段类型 |
└─options | array | false | 下拉款配置项 |
└─label | string | false | 标签 |
└─value | object | false | 值 |
└─extra | object | false | 额外扩展信息 |
downConfigs | array | false | 接口下行配置列表 |
└─id | int64 | false | No comments found. |
└─sort | int32 | false | 排序 |
└─protocolApiCode | string | false | 所属api接口 |
└─protocolAttrField | string | false | 协议属性 |
└─remark | string | false | 备注 |
└─position | string | false | 点位地址 |
└─length | int32 | false | 配置长度 |
└─createTime | string | false | 创建时间 |
└─attrName | string | false | 属性名称 |
└─dataType | string | false | 属性类型 |
└─attrRemark | string | false | 属性说明 |
└─fieldType | enum | false | 字段类型 |
└─options | array | false | 下拉款配置项 |
└─label | string | false | 标签 |
└─value | object | false | 值 |
└─extra | object | false | 额外扩展信息 |
Request-body:
{
"id": 0,
"type": "func",
"triggerMode": "active",
"code": "",
"name": "",
"status": "",
"remark": "",
"funcType": "R",
"createTime": "yyyy-MM-dd HH:mm:ss",
"protocolCode": "",
"upConfigs": [
{
"id": 0,
"sort": 0,
"protocolApiCode": "",
"protocolAttrField": "",
"remark": "",
"position": "",
"length": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"attrName": "",
"dataType": "",
"attrRemark": "",
"fieldType": "status",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"extra": {
"object": "any object"
}
}
]
}
],
"downConfigs": [
{
"id": 0,
"sort": 0,
"protocolApiCode": "",
"protocolAttrField": "",
"remark": "",
"position": "",
"length": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"attrName": "",
"dataType": "",
"attrRemark": "",
"fieldType": "status",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"extra": {
"object": "any object"
}
}
]
}
]
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/protocolApi/saveOrUpdate' --data '{
"id": 0,
"type": "func",
"triggerMode": "active",
"code": "",
"name": "",
"status": "",
"remark": "",
"funcType": "R",
"createTime": "yyyy-MM-dd HH:mm:ss",
"protocolCode": "",
"upConfigs": [
{
"id": 0,
"sort": 0,
"protocolApiCode": "",
"protocolAttrField": "",
"remark": "",
"position": "",
"length": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"attrName": "",
"dataType": "",
"attrRemark": "",
"fieldType": "status",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"extra": {
"object": "any object"
}
}
]
}
],
"downConfigs": [
{
"id": 0,
"sort": 0,
"protocolApiCode": "",
"protocolAttrField": "",
"remark": "",
"position": "",
"length": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"attrName": "",
"dataType": "",
"attrRemark": "",
"fieldType": "status",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"extra": {
"object": "any object"
}
}
]
}
]
}'2.27.4. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/protocolApi/del' --data '[
0
]'2.28. 协议属性管理
2.28.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
field | string | false | 属性代码 | ||
name | string | false | 属性名称 | ||
dataType | string | false | 数据类型 | ||
remark | string | false | 属性说明 | ||
attrType | enum | false | 读写方式 | ||
createTime | string | false | 创建时间 | ||
protocolCode | string | false | 所属协议 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─field | string | 属性代码 | - |
└─name | string | 属性名称 | - |
└─dataType | string | 数据类型 | - |
└─remark | string | 属性说明 | - |
└─attrType | enum | 读写方式 | - |
└─createTime | string | 创建时间 | - |
└─protocolCode | string | 所属协议 | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"field": "",
"name": "",
"dataType": "",
"remark": "",
"attrType": "R",
"createTime": "yyyy-MM-dd HH:mm:ss",
"protocolCode": ""
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/protocolAttr/view?size=0¤t=0&id=0&attrType=R&createTime=yyyy-MM-dd HH:mm:ss&orders[0].protocolCode=&records[0].id=0&records[0].name=&orders[0].dataType=&total=0&name=&records[0].field=&records[0].dataType=&orders[0].name=&dataType=&orders[0].remark=&isSearchCount=true&orders[0].field=&remark=&records[0].attrType=R&records[0].protocolCode=&orders[0].id=0&maxLimit=0&records[0].remark=&optimizeCountSql=true&orders[0].attrType=R&records[0].createTime=yyyy-MM-dd HH:mm:ss&field=&protocolCode=&pages=0&orders[0].createTime=yyyy-MM-dd HH:mm:ss&countId=&hitCount=true'2.28.2. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | 记录id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─field | string | 属性代码 | - |
└─name | string | 属性名称 | - |
└─dataType | string | 数据类型 | - |
└─remark | string | 属性说明 | - |
└─attrType | enum | 读写方式 | - |
└─createTime | string | 创建时间 | - |
└─protocolCode | string | 所属协议 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"field": "",
"name": "",
"dataType": "",
"remark": "",
"attrType": "R",
"createTime": "yyyy-MM-dd HH:mm:ss",
"protocolCode": ""
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/protocolAttr/edit?id=0&=d4uq6n'2.28.3. 新增或者更新记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
field | string | false | 属性代码 |
name | string | false | 属性名称 |
dataType | string | false | 数据类型 |
remark | string | false | 属性说明 |
attrType | enum | false | 读写方式 |
createTime | string | false | 创建时间 |
protocolCode | string | false | 所属协议 |
Request-body:
{
"id": 0,
"field": "",
"name": "",
"dataType": "",
"remark": "",
"attrType": "R",
"createTime": "yyyy-MM-dd HH:mm:ss",
"protocolCode": ""
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/protocolAttr/saveOrUpdate' --data '{
"id": 0,
"field": "",
"name": "",
"dataType": "",
"remark": "",
"attrType": "R",
"createTime": "yyyy-MM-dd HH:mm:ss",
"protocolCode": ""
}'2.28.4. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/protocolAttr/del' --data '[
0
]'2.29. 报文协议管理
2.29.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
name | string | false | 协议名称 | ||
code | string | false | 协议代码 | ||
version | string | false | 协议版本 | ||
type | enum | false | 协议类型 | ||
gatewayType | enum | false | 网关类型 | ||
connectionType | enum | false | 连接类型 | ||
ctrlMode | enum | false | 操控方式 | ||
implClass | string | false | 实现类 | ||
implMode | enum | false | 实现方式 | ||
jarPath | string | false | jar文件路径 | ||
remark | string | false | 协议备注 | ||
checkType | string | false | 校验类型 | ||
decoderType | string | false | 解码器类型 | ||
decoderConfig | string | false | 解码器配置 | ||
createTime | string | false | 创建时间 | ||
updateTime | string | false | 更新时间 | ||
deviceCount | int64 | false | 绑定的设备数量 | ||
productName | string | false | 产品名称 | ||
productCode | string | false | 产品代码 | ||
deviceConfig | array | false | 设备配置 | ||
└─field | string | false | 字段名 | ||
└─label | string | false | 字段说明 | ||
└─extra | string | false | 额外说明 | ||
└─type | string | false | 值类型(string, number, hidden) | ||
└─required | boolean | false | 是否必填 | ||
└─defaultValue | object | false | 默认值 | ||
└─placeholder | string | false | No comments found. | ||
└─options | array | false | 配置值 | ||
└─label | string | false | 标签 | ||
└─value | object | false | 值 | ||
└─disabled | boolean | false | 是否禁用 | ||
└─checked | boolean | false | 是否默认选中 | ||
└─children | array | false | 子项 | ||
└─extra | object | false | 额外扩展信息 | ||
└─selectable | boolean | false | 可选中 | ||
└─checkable | boolean | false | 复选框是否能被选中 | ||
└─config | map | false | 配置项 | ||
└─any object | object | false | any object. | ||
productConfig | array | false | 产品配置 | ||
└─field | string | false | 字段名 | ||
└─label | string | false | 字段说明 | ||
└─extra | string | false | 额外说明 | ||
└─type | string | false | 值类型(string, number, hidden) | ||
└─required | boolean | false | 是否必填 | ||
└─defaultValue | object | false | 默认值 | ||
└─placeholder | string | false | No comments found. | ||
└─options | array | false | 配置值 | ||
└─label | string | false | 标签 | ||
└─value | object | false | 值 | ||
└─disabled | boolean | false | 是否禁用 | ||
└─checked | boolean | false | 是否默认选中 | ||
└─children | array | false | 子项 | ||
└─extra | object | false | 额外扩展信息 | ||
└─selectable | boolean | false | 可选中 | ||
└─checkable | boolean | false | 复选框是否能被选中 | ||
└─config | map | false | 配置项 | ||
└─any object | object | false | any object. | ||
gatewayConfig | array | false | 网关配置 | ||
└─field | string | false | 字段名 | ||
└─label | string | false | 字段说明 | ||
└─extra | string | false | 额外说明 | ||
└─type | string | false | 值类型(string, number, hidden) | ||
└─required | boolean | false | 是否必填 | ||
└─defaultValue | object | false | 默认值 | ||
└─placeholder | string | false | No comments found. | ||
└─options | array | false | 配置值 | ||
└─label | string | false | 标签 | ||
└─value | object | false | 值 | ||
└─disabled | boolean | false | 是否禁用 | ||
└─checked | boolean | false | 是否默认选中 | ||
└─children | array | false | 子项 | ||
└─extra | object | false | 额外扩展信息 | ||
└─selectable | boolean | false | 可选中 | ||
└─checkable | boolean | false | 复选框是否能被选中 | ||
└─config | map | false | 配置项 | ||
└─any object | object | false | any object. | ||
attrs | array | false | 协议属性列表 | ||
└─id | int64 | false | No comments found. | ||
└─field | string | false | 属性代码 | ||
└─name | string | false | 属性名称 | ||
└─dataType | string | false | 数据类型 | ||
└─remark | string | false | 属性说明 | ||
└─attrType | enum | false | 读写方式 | ||
└─createTime | string | false | 创建时间 | ||
└─protocolCode | string | false | 所属协议 | ||
funcApis | array | false | 协议功能接口列表 | ||
└─id | int64 | false | No comments found. | ||
└─type | enum | false | 接口类型 | ||
└─triggerMode | enum | false | 事件触发方式 | ||
└─code | string | false | 接口代码 | ||
└─name | string | false | 接口名称 | ||
└─status | string | false | 接口状态 | ||
└─remark | string | false | 接口说明 | ||
└─funcType | enum | false | 功能类型 | ||
└─createTime | string | false | 创建时间 | ||
└─protocolCode | string | false | 所属协议 | ||
└─upConfigs | array | false | 接口上行配置列表 | ||
└─id | int64 | false | No comments found. | ||
└─sort | int32 | false | 排序 | ||
└─protocolApiCode | string | false | 所属api接口 | ||
└─protocolAttrField | string | false | 协议属性 | ||
└─remark | string | false | 备注 | ||
└─position | string | false | 点位地址 | ||
└─length | int32 | false | 配置长度 | ||
└─createTime | string | false | 创建时间 | ||
└─attrName | string | false | 属性名称 | ||
└─dataType | string | false | 属性类型 | ||
└─attrRemark | string | false | 属性说明 | ||
└─fieldType | enum | false | 字段类型 | ||
└─options | array | false | 下拉款配置项 | ||
└─label | string | false | 标签 | ||
└─value | object | false | 值 | ||
└─extra | object | false | 额外扩展信息 | ||
└─downConfigs | array | false | 接口下行配置列表 | ||
└─id | int64 | false | No comments found. | ||
└─sort | int32 | false | 排序 | ||
└─protocolApiCode | string | false | 所属api接口 | ||
└─protocolAttrField | string | false | 协议属性 | ||
└─remark | string | false | 备注 | ||
└─position | string | false | 点位地址 | ||
└─length | int32 | false | 配置长度 | ||
└─createTime | string | false | 创建时间 | ||
└─attrName | string | false | 属性名称 | ||
└─dataType | string | false | 属性类型 | ||
└─attrRemark | string | false | 属性说明 | ||
└─fieldType | enum | false | 字段类型 | ||
└─options | array | false | 下拉款配置项 | ||
└─label | string | false | 标签 | ||
└─value | object | false | 值 | ||
└─extra | object | false | 额外扩展信息 | ||
eventApis | array | false | 协议事件接口列表 | ||
└─id | int64 | false | No comments found. | ||
└─type | enum | false | 接口类型 | ||
└─triggerMode | enum | false | 事件触发方式 | ||
└─code | string | false | 接口代码 | ||
└─name | string | false | 接口名称 | ||
└─status | string | false | 接口状态 | ||
└─remark | string | false | 接口说明 | ||
└─funcType | enum | false | 功能类型 | ||
└─createTime | string | false | 创建时间 | ||
└─protocolCode | string | false | 所属协议 | ||
└─upConfigs | array | false | 接口上行配置列表 | ||
└─id | int64 | false | No comments found. | ||
└─sort | int32 | false | 排序 | ||
└─protocolApiCode | string | false | 所属api接口 | ||
└─protocolAttrField | string | false | 协议属性 | ||
└─remark | string | false | 备注 | ||
└─position | string | false | 点位地址 | ||
└─length | int32 | false | 配置长度 | ||
└─createTime | string | false | 创建时间 | ||
└─attrName | string | false | 属性名称 | ||
└─dataType | string | false | 属性类型 | ||
└─attrRemark | string | false | 属性说明 | ||
└─fieldType | enum | false | 字段类型 | ||
└─options | array | false | 下拉款配置项 | ||
└─label | string | false | 标签 | ||
└─value | object | false | 值 | ||
└─extra | object | false | 额外扩展信息 | ||
└─downConfigs | array | false | 接口下行配置列表 | ||
└─id | int64 | false | No comments found. | ||
└─sort | int32 | false | 排序 | ||
└─protocolApiCode | string | false | 所属api接口 | ||
└─protocolAttrField | string | false | 协议属性 | ||
└─remark | string | false | 备注 | ||
└─position | string | false | 点位地址 | ||
└─length | int32 | false | 配置长度 | ||
└─createTime | string | false | 创建时间 | ||
└─attrName | string | false | 属性名称 | ||
└─dataType | string | false | 属性类型 | ||
└─attrRemark | string | false | 属性说明 | ||
└─fieldType | enum | false | 字段类型 | ||
└─options | array | false | 下拉款配置项 | ||
└─label | string | false | 标签 | ||
└─value | object | false | 值 | ||
└─extra | object | false | 额外扩展信息 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─name | string | 协议名称 | - |
└─code | string | 协议代码 | - |
└─version | string | 协议版本 | - |
└─type | enum | 协议类型 | - |
└─gatewayType | enum | 网关类型 | - |
└─connectionType | enum | 连接类型 | - |
└─ctrlMode | enum | 操控方式 | - |
└─implClass | string | 实现类 | - |
└─implMode | enum | 实现方式 | - |
└─jarPath | string | jar文件路径 | - |
└─remark | string | 协议备注 | - |
└─checkType | string | 校验类型 | - |
└─decoderType | string | 解码器类型 | - |
└─decoderConfig | string | 解码器配置 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
└─deviceCount | int64 | 绑定的设备数量 | - |
└─productName | string | 产品名称 | - |
└─productCode | string | 产品代码 | - |
└─deviceConfig | array | 设备配置 | - |
└─field | string | 字段名 | - |
└─label | string | 字段说明 | - |
└─extra | string | 额外说明 | - |
└─type | string | 值类型(string, number, hidden) | - |
└─required | boolean | 是否必填 | - |
└─defaultValue | object | 默认值 | - |
└─placeholder | string | No comments found. | - |
└─options | array | 配置值 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─disabled | boolean | 是否禁用 | - |
└─checked | boolean | 是否默认选中 | - |
└─children | array | 子项 | - |
└─extra | object | 额外扩展信息 | - |
└─selectable | boolean | 可选中 | - |
└─checkable | boolean | 复选框是否能被选中 | - |
└─config | map | 配置项 | - |
└─any object | object | any object. | - |
└─productConfig | array | 产品配置 | - |
└─field | string | 字段名 | - |
└─label | string | 字段说明 | - |
└─extra | string | 额外说明 | - |
└─type | string | 值类型(string, number, hidden) | - |
└─required | boolean | 是否必填 | - |
└─defaultValue | object | 默认值 | - |
└─placeholder | string | No comments found. | - |
└─options | array | 配置值 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─disabled | boolean | 是否禁用 | - |
└─checked | boolean | 是否默认选中 | - |
└─children | array | 子项 | - |
└─extra | object | 额外扩展信息 | - |
└─selectable | boolean | 可选中 | - |
└─checkable | boolean | 复选框是否能被选中 | - |
└─config | map | 配置项 | - |
└─any object | object | any object. | - |
└─gatewayConfig | array | 网关配置 | - |
└─field | string | 字段名 | - |
└─label | string | 字段说明 | - |
└─extra | string | 额外说明 | - |
└─type | string | 值类型(string, number, hidden) | - |
└─required | boolean | 是否必填 | - |
└─defaultValue | object | 默认值 | - |
└─placeholder | string | No comments found. | - |
└─options | array | 配置值 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─disabled | boolean | 是否禁用 | - |
└─checked | boolean | 是否默认选中 | - |
└─children | array | 子项 | - |
└─extra | object | 额外扩展信息 | - |
└─selectable | boolean | 可选中 | - |
└─checkable | boolean | 复选框是否能被选中 | - |
└─config | map | 配置项 | - |
└─any object | object | any object. | - |
└─attrs | array | 协议属性列表 | - |
└─id | int64 | No comments found. | - |
└─field | string | 属性代码 | - |
└─name | string | 属性名称 | - |
└─dataType | string | 数据类型 | - |
└─remark | string | 属性说明 | - |
└─attrType | enum | 读写方式 | - |
└─createTime | string | 创建时间 | - |
└─protocolCode | string | 所属协议 | - |
└─funcApis | array | 协议功能接口列表 | - |
└─id | int64 | No comments found. | - |
└─type | enum | 接口类型 | - |
└─triggerMode | enum | 事件触发方式 | - |
└─code | string | 接口代码 | - |
└─name | string | 接口名称 | - |
└─status | string | 接口状态 | - |
└─remark | string | 接口说明 | - |
└─funcType | enum | 功能类型 | - |
└─createTime | string | 创建时间 | - |
└─protocolCode | string | 所属协议 | - |
└─upConfigs | array | 接口上行配置列表 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─protocolApiCode | string | 所属api接口 | - |
└─protocolAttrField | string | 协议属性 | - |
└─remark | string | 备注 | - |
└─position | string | 点位地址 | - |
└─length | int32 | 配置长度 | - |
└─createTime | string | 创建时间 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─attrRemark | string | 属性说明 | - |
└─fieldType | enum | 字段类型 | - |
└─options | array | 下拉款配置项 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─extra | object | 额外扩展信息 | - |
└─downConfigs | array | 接口下行配置列表 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─protocolApiCode | string | 所属api接口 | - |
└─protocolAttrField | string | 协议属性 | - |
└─remark | string | 备注 | - |
└─position | string | 点位地址 | - |
└─length | int32 | 配置长度 | - |
└─createTime | string | 创建时间 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─attrRemark | string | 属性说明 | - |
└─fieldType | enum | 字段类型 | - |
└─options | array | 下拉款配置项 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─extra | object | 额外扩展信息 | - |
└─eventApis | array | 协议事件接口列表 | - |
└─id | int64 | No comments found. | - |
└─type | enum | 接口类型 | - |
└─triggerMode | enum | 事件触发方式 | - |
└─code | string | 接口代码 | - |
└─name | string | 接口名称 | - |
└─status | string | 接口状态 | - |
└─remark | string | 接口说明 | - |
└─funcType | enum | 功能类型 | - |
└─createTime | string | 创建时间 | - |
└─protocolCode | string | 所属协议 | - |
└─upConfigs | array | 接口上行配置列表 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─protocolApiCode | string | 所属api接口 | - |
└─protocolAttrField | string | 协议属性 | - |
└─remark | string | 备注 | - |
└─position | string | 点位地址 | - |
└─length | int32 | 配置长度 | - |
└─createTime | string | 创建时间 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─attrRemark | string | 属性说明 | - |
└─fieldType | enum | 字段类型 | - |
└─options | array | 下拉款配置项 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─extra | object | 额外扩展信息 | - |
└─downConfigs | array | 接口下行配置列表 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─protocolApiCode | string | 所属api接口 | - |
└─protocolAttrField | string | 协议属性 | - |
└─remark | string | 备注 | - |
└─position | string | 点位地址 | - |
└─length | int32 | 配置长度 | - |
└─createTime | string | 创建时间 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─attrRemark | string | 属性说明 | - |
└─fieldType | enum | 字段类型 | - |
└─options | array | 下拉款配置项 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─extra | object | 额外扩展信息 | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"name": "",
"code": "",
"version": "",
"type": "TCP",
"gatewayType": "Direct",
"connectionType": "Client",
"ctrlMode": "COMMON",
"implClass": "",
"implMode": "Jar",
"jarPath": "",
"remark": "",
"checkType": "",
"decoderType": "",
"decoderConfig": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"deviceCount": 0,
"productName": "",
"productCode": "",
"deviceConfig": [
{
"field": "",
"label": "",
"extra": "",
"type": "",
"required": true,
"defaultValue": {
"object": "any object"
},
"placeholder": "",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"disabled": true,
"checked": true,
"children": [
{
"$ref": ".."
}
],
"extra": {
"object": "any object"
},
"selectable": true,
"checkable": true,
"config": {
"mapKey": {}
}
}
]
}
],
"productConfig": [
{
"field": "",
"label": "",
"extra": "",
"type": "",
"required": true,
"defaultValue": {
"object": "any object"
},
"placeholder": "",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"disabled": true,
"checked": true,
"children": [
{
"$ref": ".."
}
],
"extra": {
"object": "any object"
},
"selectable": true,
"checkable": true,
"config": {
"mapKey": {}
}
}
]
}
],
"gatewayConfig": [
{
"field": "",
"label": "",
"extra": "",
"type": "",
"required": true,
"defaultValue": {
"object": "any object"
},
"placeholder": "",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"disabled": true,
"checked": true,
"children": [
{
"$ref": ".."
}
],
"extra": {
"object": "any object"
},
"selectable": true,
"checkable": true,
"config": {
"mapKey": {}
}
}
]
}
],
"attrs": [
{
"id": 0,
"field": "",
"name": "",
"dataType": "",
"remark": "",
"attrType": "R",
"createTime": "yyyy-MM-dd HH:mm:ss",
"protocolCode": ""
}
],
"funcApis": [
{
"id": 0,
"type": "func",
"triggerMode": "active",
"code": "",
"name": "",
"status": "",
"remark": "",
"funcType": "R",
"createTime": "yyyy-MM-dd HH:mm:ss",
"protocolCode": "",
"upConfigs": [
{
"id": 0,
"sort": 0,
"protocolApiCode": "",
"protocolAttrField": "",
"remark": "",
"position": "",
"length": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"attrName": "",
"dataType": "",
"attrRemark": "",
"fieldType": "status",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"extra": {
"object": "any object"
}
}
]
}
],
"downConfigs": [
{
"id": 0,
"sort": 0,
"protocolApiCode": "",
"protocolAttrField": "",
"remark": "",
"position": "",
"length": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"attrName": "",
"dataType": "",
"attrRemark": "",
"fieldType": "status",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"extra": {
"object": "any object"
}
}
]
}
]
}
],
"eventApis": [
{
"id": 0,
"type": "func",
"triggerMode": "active",
"code": "",
"name": "",
"status": "",
"remark": "",
"funcType": "R",
"createTime": "yyyy-MM-dd HH:mm:ss",
"protocolCode": "",
"upConfigs": [
{
"id": 0,
"sort": 0,
"protocolApiCode": "",
"protocolAttrField": "",
"remark": "",
"position": "",
"length": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"attrName": "",
"dataType": "",
"attrRemark": "",
"fieldType": "status",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"extra": {
"object": "any object"
}
}
]
}
],
"downConfigs": [
{
"id": 0,
"sort": 0,
"protocolApiCode": "",
"protocolAttrField": "",
"remark": "",
"position": "",
"length": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"attrName": "",
"dataType": "",
"attrRemark": "",
"fieldType": "status",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"extra": {
"object": "any object"
}
}
]
}
]
}
]
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/protocol/view?size=0¤t=0&id=0&type=TCP&gatewayType=Direct&connectionType=Client&ctrlMode=COMMON&implMode=Jar&createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&deviceCount=0&required=true&disabled=true&checked=true&selectable=true&checkable=true&attrType=R&triggerMode=active&funcType=R&sort=0&length=0&fieldType=status&eventApis[0].downConfigs[0].position=&gatewayConfig[0].options[0].selectable=true&orders[0].name=&deviceConfig[0].options[0].checkable=true&gatewayConfig[0].field=&funcApis[0].protocolCode=&orders[0].decoderType=&maxLimit=0&productConfig[0].label=&eventApis[0].id=0&funcApis[0].downConfigs[0].options[0].label=&records[0].type=TCP&productConfig[0].options[0].disabled=true&funcApis[0].upConfigs[0].attrName=&funcApis[0].upConfigs[0].createTime=yyyy-MM-dd HH:mm:ss&productName=&eventApis[0].downConfigs[0].dataType=&productConfig[0].options[0].checkable=true&eventApis[0].upConfigs[0].attrName=&eventApis[0].upConfigs[0].fieldType=status&eventApis[0].status=&eventApis[0].createTime=yyyy-MM-dd HH:mm:ss&records[0].id=0&records[0].version=&funcApis[0].type=func&deviceConfig[0].options[0].checked=true&funcApis[0].createTime=yyyy-MM-dd HH:mm:ss&attrs[0].remark=&records[0].ctrlMode=COMMON&funcApis[0].upConfigs[0].protocolAttrField=&productConfig[0].options[0].selectable=true&funcApis[0].downConfigs[0].id=0&funcApis[0].id=0&eventApis[0].funcType=R&deviceConfig[0].extra=&funcApis[0].status=&orders[0].code=&records[0].remark=&eventApis[0].downConfigs[0].length=0&pages=0&checkType=&orders[0].updateTime=yyyy-MM-dd HH:mm:ss&records[0].code=&gatewayConfig[0].type=&eventApis[0].upConfigs[0].options[0].label=&deviceConfig[0].placeholder=&orders[0].remark=&total=0&funcApis[0].downConfigs[0].fieldType=status&funcApis[0].downConfigs[0].createTime=yyyy-MM-dd HH:mm:ss&eventApis[0].downConfigs[0].options[0].label=&records[0].name=&records[0].decoderConfig=&funcApis[0].name=&eventApis[0].downConfigs[0].sort=0&orders[0].gatewayType=Direct&deviceConfig[0].label=&productConfig[0].field=&eventApis[0].upConfigs[0].position=&funcApis[0].funcType=R&funcApis[0].code=&implClass=&productCode=&deviceConfig[0].type=&eventApis[0].upConfigs[0].protocolApiCode=&attrs[0].dataType=&orders[0].version=&productConfig[0].type=&deviceConfig[0].options[0].selectable=true&orders[0].jarPath=&eventApis[0].triggerMode=active&orders[0].ctrlMode=COMMON&orders[0].type=TCP&jarPath=&eventApis[0].downConfigs[0].fieldType=status&version=&attrs[0].name=&funcApis[0].upConfigs[0].fieldType=status&funcApis[0].downConfigs[0].sort=0&orders[0].createTime=yyyy-MM-dd HH:mm:ss&funcApis[0].downConfigs[0].length=0&deviceConfig[0].options[0].disabled=true&funcApis[0].downConfigs[0].attrName=&gatewayConfig[0].label=&attrs[0].id=0&funcApis[0].downConfigs[0].remark=&records[0].decoderType=&orders[0].implMode=Jar&remark=&eventApis[0].type=func&attrs[0].createTime=yyyy-MM-dd HH:mm:ss&eventApis[0].downConfigs[0].createTime=yyyy-MM-dd HH:mm:ss&funcApis[0].upConfigs[0].id=0&records[0].connectionType=Client&funcApis[0].upConfigs[0].sort=0&gatewayConfig[0].placeholder=&eventApis[0].upConfigs[0].length=0&attrs[0].protocolCode=&records[0].createTime=yyyy-MM-dd HH:mm:ss&eventApis[0].upConfigs[0].id=0&funcApis[0].upConfigs[0].length=0&eventApis[0].upConfigs[0].sort=0&funcApis[0].downConfigs[0].position=&records[0].implMode=Jar&records[0].gatewayType=Direct&gatewayConfig[0].options[0].disabled=true&records[0].updateTime=yyyy-MM-dd HH:mm:ss&records[0].implClass=&gatewayConfig[0].options[0].checked=true&decoderConfig=&productConfig[0].options[0].checked=true&funcApis[0].remark=&eventApis[0].downConfigs[0].attrName=&eventApis[0].protocolCode=&orders[0].decoderConfig=&funcApis[0].downConfigs[0].protocolApiCode=&name=&productConfig[0].extra=&funcApis[0].downConfigs[0].attrRemark=&eventApis[0].downConfigs[0].id=0&gatewayConfig[0].options[0].label=&countId=&gatewayConfig[0].required=true&code=&orders[0].checkType=&productConfig[0].required=true&eventApis[0].name=&eventApis[0].downConfigs[0].remark=&gatewayConfig[0].options[0].checkable=true&eventApis[0].code=&deviceConfig[0].options[0].label=&productConfig[0].options[0].label=&funcApis[0].downConfigs[0].protocolAttrField=&orders[0].id=0&funcApis[0].upConfigs[0].remark=&records[0].checkType=&funcApis[0].triggerMode=active&funcApis[0].upConfigs[0].dataType=&funcApis[0].upConfigs[0].position=&isSearchCount=true&deviceConfig[0].field=&eventApis[0].upConfigs[0].protocolAttrField=&optimizeCountSql=true&funcApis[0].upConfigs[0].protocolApiCode=&orders[0].implClass=&records[0].jarPath=&decoderType=&deviceConfig[0].required=true&orders[0].connectionType=Client&funcApis[0].upConfigs[0].options[0].label=&eventApis[0].remark=&eventApis[0].upConfigs[0].dataType=&eventApis[0].upConfigs[0].remark=&attrs[0].attrType=R&productConfig[0].placeholder=&eventApis[0].downConfigs[0].protocolAttrField=&funcApis[0].upConfigs[0].attrRemark=&eventApis[0].upConfigs[0].createTime=yyyy-MM-dd HH:mm:ss&eventApis[0].downConfigs[0].protocolApiCode=&hitCount=true&gatewayConfig[0].extra=&eventApis[0].upConfigs[0].attrRemark=&eventApis[0].downConfigs[0].attrRemark=&attrs[0].field=&funcApis[0].downConfigs[0].dataType='2.29.2. 获取协议列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取协议列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. | ||
name | string | false | 协议名称 | ||
code | string | false | 协议代码 | ||
version | string | false | 协议版本 | ||
type | enum | false | 协议类型 | ||
gatewayType | enum | false | 网关类型 | ||
connectionType | enum | false | 连接类型 | ||
ctrlMode | enum | false | 操控方式 | ||
implClass | string | false | 实现类 | ||
implMode | enum | false | 实现方式 | ||
jarPath | string | false | jar文件路径 | ||
remark | string | false | 协议备注 | ||
checkType | string | false | 校验类型 | ||
decoderType | string | false | 解码器类型 | ||
decoderConfig | string | false | 解码器配置 | ||
createTime | string | false | 创建时间 | ||
updateTime | string | false | 更新时间 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─name | string | 协议名称 | - |
└─code | string | 协议代码 | - |
└─version | string | 协议版本 | - |
└─type | enum | 协议类型 | - |
└─gatewayType | enum | 网关类型 | - |
└─connectionType | enum | 连接类型 | - |
└─ctrlMode | enum | 操控方式 | - |
└─implClass | string | 实现类 | - |
└─implMode | enum | 实现方式 | - |
└─jarPath | string | jar文件路径 | - |
└─remark | string | 协议备注 | - |
└─checkType | string | 校验类型 | - |
└─decoderType | string | 解码器类型 | - |
└─decoderConfig | string | 解码器配置 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"name": "",
"code": "",
"version": "",
"type": "TCP",
"gatewayType": "Direct",
"connectionType": "Client",
"ctrlMode": "COMMON",
"implClass": "",
"implMode": "Jar",
"jarPath": "",
"remark": "",
"checkType": "",
"decoderType": "",
"decoderConfig": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/protocol/list?id=0&type=TCP&gatewayType=Direct&connectionType=Client&ctrlMode=COMMON&implMode=Jar&createTime=yyyy-MM-dd HH:mm:ss&updateTime=yyyy-MM-dd HH:mm:ss&implClass=&decoderType=&version=&jarPath=&checkType=&decoderConfig=&remark=&code=&name='2.29.3. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | 记录id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─name | string | 协议名称 | - |
└─code | string | 协议代码 | - |
└─version | string | 协议版本 | - |
└─type | enum | 协议类型 | - |
└─gatewayType | enum | 网关类型 | - |
└─connectionType | enum | 连接类型 | - |
└─ctrlMode | enum | 操控方式 | - |
└─implClass | string | 实现类 | - |
└─implMode | enum | 实现方式 | - |
└─jarPath | string | jar文件路径 | - |
└─remark | string | 协议备注 | - |
└─checkType | string | 校验类型 | - |
└─decoderType | string | 解码器类型 | - |
└─decoderConfig | string | 解码器配置 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"name": "",
"code": "",
"version": "",
"type": "TCP",
"gatewayType": "Direct",
"connectionType": "Client",
"ctrlMode": "COMMON",
"implClass": "",
"implMode": "Jar",
"jarPath": "",
"remark": "",
"checkType": "",
"decoderType": "",
"decoderConfig": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/protocol/edit?id=0&=e5gxvm'2.29.4. 新增或者更新记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
name | string | false | 协议名称 |
code | string | false | 协议代码 |
version | string | false | 协议版本 |
type | enum | false | 协议类型 |
gatewayType | enum | false | 网关类型 |
connectionType | enum | false | 连接类型 |
ctrlMode | enum | false | 操控方式 |
implClass | string | false | 实现类 |
implMode | enum | false | 实现方式 |
jarPath | string | false | jar文件路径 |
remark | string | false | 协议备注 |
checkType | string | false | 校验类型 |
decoderType | string | false | 解码器类型 |
decoderConfig | string | false | 解码器配置 |
createTime | string | false | 创建时间 |
updateTime | string | false | 更新时间 |
Request-body:
{
"id": 0,
"name": "",
"code": "",
"version": "",
"type": "TCP",
"gatewayType": "Direct",
"connectionType": "Client",
"ctrlMode": "COMMON",
"implClass": "",
"implMode": "Jar",
"jarPath": "",
"remark": "",
"checkType": "",
"decoderType": "",
"decoderConfig": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/protocol/saveOrUpdate' --data '{
"id": 0,
"name": "",
"code": "",
"version": "",
"type": "TCP",
"gatewayType": "Direct",
"connectionType": "Client",
"ctrlMode": "COMMON",
"implClass": "",
"implMode": "Jar",
"jarPath": "",
"remark": "",
"checkType": "",
"decoderType": "",
"decoderConfig": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}'2.29.5. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/protocol/del' --data '[
0
]'2.29.6. 导入Jar协议
Type: POST
Author: iteaj
Content-Type: multipart/form-data
Description: 导入Jar协议
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
file | file | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─name | string | 协议名称 | - |
└─code | string | 协议代码 | - |
└─version | string | 协议版本 | - |
└─type | enum | 协议类型 | - |
└─gatewayType | enum | 网关类型 | - |
└─connectionType | enum | 连接类型 | - |
└─ctrlMode | enum | 操控方式 | - |
└─implClass | string | 实现类 | - |
└─implMode | enum | 实现方式 | - |
└─jarPath | string | jar文件路径 | - |
└─remark | string | 协议备注 | - |
└─checkType | string | 校验类型 | - |
└─decoderType | string | 解码器类型 | - |
└─decoderConfig | string | 解码器配置 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"name": "",
"code": "",
"version": "",
"type": "TCP",
"gatewayType": "Direct",
"connectionType": "Client",
"ctrlMode": "COMMON",
"implClass": "",
"implMode": "Jar",
"jarPath": "",
"remark": "",
"checkType": "",
"decoderType": "",
"decoderConfig": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss"
}
}Curl-example:
curl -X POST -H 'Content-Type: multipart/form-data' -F 'file=' -i 'http://127.0.0.1:8085/api/iot/protocol/loadProtocol'2.29.7. 获取协议详情
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取协议详情
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─name | string | 协议名称 | - |
└─code | string | 协议代码 | - |
└─version | string | 协议版本 | - |
└─type | enum | 协议类型 | - |
└─gatewayType | enum | 网关类型 | - |
└─connectionType | enum | 连接类型 | - |
└─ctrlMode | enum | 操控方式 | - |
└─implClass | string | 实现类 | - |
└─implMode | enum | 实现方式 | - |
└─jarPath | string | jar文件路径 | - |
└─remark | string | 协议备注 | - |
└─checkType | string | 校验类型 | - |
└─decoderType | string | 解码器类型 | - |
└─decoderConfig | string | 解码器配置 | - |
└─createTime | string | 创建时间 | - |
└─updateTime | string | 更新时间 | - |
└─deviceCount | int64 | 绑定的设备数量 | - |
└─productName | string | 产品名称 | - |
└─productCode | string | 产品代码 | - |
└─deviceConfig | array | 设备配置 | - |
└─field | string | 字段名 | - |
└─label | string | 字段说明 | - |
└─extra | string | 额外说明 | - |
└─type | string | 值类型(string, number, hidden) | - |
└─required | boolean | 是否必填 | - |
└─defaultValue | object | 默认值 | - |
└─placeholder | string | No comments found. | - |
└─options | array | 配置值 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─disabled | boolean | 是否禁用 | - |
└─checked | boolean | 是否默认选中 | - |
└─children | array | 子项 | - |
└─extra | object | 额外扩展信息 | - |
└─selectable | boolean | 可选中 | - |
└─checkable | boolean | 复选框是否能被选中 | - |
└─config | map | 配置项 | - |
└─any object | object | any object. | - |
└─productConfig | array | 产品配置 | - |
└─field | string | 字段名 | - |
└─label | string | 字段说明 | - |
└─extra | string | 额外说明 | - |
└─type | string | 值类型(string, number, hidden) | - |
└─required | boolean | 是否必填 | - |
└─defaultValue | object | 默认值 | - |
└─placeholder | string | No comments found. | - |
└─options | array | 配置值 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─disabled | boolean | 是否禁用 | - |
└─checked | boolean | 是否默认选中 | - |
└─children | array | 子项 | - |
└─extra | object | 额外扩展信息 | - |
└─selectable | boolean | 可选中 | - |
└─checkable | boolean | 复选框是否能被选中 | - |
└─config | map | 配置项 | - |
└─any object | object | any object. | - |
└─gatewayConfig | array | 网关配置 | - |
└─field | string | 字段名 | - |
└─label | string | 字段说明 | - |
└─extra | string | 额外说明 | - |
└─type | string | 值类型(string, number, hidden) | - |
└─required | boolean | 是否必填 | - |
└─defaultValue | object | 默认值 | - |
└─placeholder | string | No comments found. | - |
└─options | array | 配置值 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─disabled | boolean | 是否禁用 | - |
└─checked | boolean | 是否默认选中 | - |
└─children | array | 子项 | - |
└─extra | object | 额外扩展信息 | - |
└─selectable | boolean | 可选中 | - |
└─checkable | boolean | 复选框是否能被选中 | - |
└─config | map | 配置项 | - |
└─any object | object | any object. | - |
└─attrs | array | 协议属性列表 | - |
└─id | int64 | No comments found. | - |
└─field | string | 属性代码 | - |
└─name | string | 属性名称 | - |
└─dataType | string | 数据类型 | - |
└─remark | string | 属性说明 | - |
└─attrType | enum | 读写方式 | - |
└─createTime | string | 创建时间 | - |
└─protocolCode | string | 所属协议 | - |
└─funcApis | array | 协议功能接口列表 | - |
└─id | int64 | No comments found. | - |
└─type | enum | 接口类型 | - |
└─triggerMode | enum | 事件触发方式 | - |
└─code | string | 接口代码 | - |
└─name | string | 接口名称 | - |
└─status | string | 接口状态 | - |
└─remark | string | 接口说明 | - |
└─funcType | enum | 功能类型 | - |
└─createTime | string | 创建时间 | - |
└─protocolCode | string | 所属协议 | - |
└─upConfigs | array | 接口上行配置列表 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─protocolApiCode | string | 所属api接口 | - |
└─protocolAttrField | string | 协议属性 | - |
└─remark | string | 备注 | - |
└─position | string | 点位地址 | - |
└─length | int32 | 配置长度 | - |
└─createTime | string | 创建时间 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─attrRemark | string | 属性说明 | - |
└─fieldType | enum | 字段类型 | - |
└─options | array | 下拉款配置项 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─extra | object | 额外扩展信息 | - |
└─downConfigs | array | 接口下行配置列表 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─protocolApiCode | string | 所属api接口 | - |
└─protocolAttrField | string | 协议属性 | - |
└─remark | string | 备注 | - |
└─position | string | 点位地址 | - |
└─length | int32 | 配置长度 | - |
└─createTime | string | 创建时间 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─attrRemark | string | 属性说明 | - |
└─fieldType | enum | 字段类型 | - |
└─options | array | 下拉款配置项 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─extra | object | 额外扩展信息 | - |
└─eventApis | array | 协议事件接口列表 | - |
└─id | int64 | No comments found. | - |
└─type | enum | 接口类型 | - |
└─triggerMode | enum | 事件触发方式 | - |
└─code | string | 接口代码 | - |
└─name | string | 接口名称 | - |
└─status | string | 接口状态 | - |
└─remark | string | 接口说明 | - |
└─funcType | enum | 功能类型 | - |
└─createTime | string | 创建时间 | - |
└─protocolCode | string | 所属协议 | - |
└─upConfigs | array | 接口上行配置列表 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─protocolApiCode | string | 所属api接口 | - |
└─protocolAttrField | string | 协议属性 | - |
└─remark | string | 备注 | - |
└─position | string | 点位地址 | - |
└─length | int32 | 配置长度 | - |
└─createTime | string | 创建时间 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─attrRemark | string | 属性说明 | - |
└─fieldType | enum | 字段类型 | - |
└─options | array | 下拉款配置项 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─extra | object | 额外扩展信息 | - |
└─downConfigs | array | 接口下行配置列表 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─protocolApiCode | string | 所属api接口 | - |
└─protocolAttrField | string | 协议属性 | - |
└─remark | string | 备注 | - |
└─position | string | 点位地址 | - |
└─length | int32 | 配置长度 | - |
└─createTime | string | 创建时间 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─attrRemark | string | 属性说明 | - |
└─fieldType | enum | 字段类型 | - |
└─options | array | 下拉款配置项 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─extra | object | 额外扩展信息 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"name": "",
"code": "",
"version": "",
"type": "TCP",
"gatewayType": "Direct",
"connectionType": "Client",
"ctrlMode": "COMMON",
"implClass": "",
"implMode": "Jar",
"jarPath": "",
"remark": "",
"checkType": "",
"decoderType": "",
"decoderConfig": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"updateTime": "yyyy-MM-dd HH:mm:ss",
"deviceCount": 0,
"productName": "",
"productCode": "",
"deviceConfig": [
{
"field": "",
"label": "",
"extra": "",
"type": "",
"required": true,
"defaultValue": {
"object": "any object"
},
"placeholder": "",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"disabled": true,
"checked": true,
"children": [
{
"$ref": ".."
}
],
"extra": {
"object": "any object"
},
"selectable": true,
"checkable": true,
"config": {
"mapKey": {}
}
}
]
}
],
"productConfig": [
{
"field": "",
"label": "",
"extra": "",
"type": "",
"required": true,
"defaultValue": {
"object": "any object"
},
"placeholder": "",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"disabled": true,
"checked": true,
"children": [
{
"$ref": ".."
}
],
"extra": {
"object": "any object"
},
"selectable": true,
"checkable": true,
"config": {
"mapKey": {}
}
}
]
}
],
"gatewayConfig": [
{
"field": "",
"label": "",
"extra": "",
"type": "",
"required": true,
"defaultValue": {
"object": "any object"
},
"placeholder": "",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"disabled": true,
"checked": true,
"children": [
{
"$ref": ".."
}
],
"extra": {
"object": "any object"
},
"selectable": true,
"checkable": true,
"config": {
"mapKey": {}
}
}
]
}
],
"attrs": [
{
"id": 0,
"field": "",
"name": "",
"dataType": "",
"remark": "",
"attrType": "R",
"createTime": "yyyy-MM-dd HH:mm:ss",
"protocolCode": ""
}
],
"funcApis": [
{
"id": 0,
"type": "func",
"triggerMode": "active",
"code": "",
"name": "",
"status": "",
"remark": "",
"funcType": "R",
"createTime": "yyyy-MM-dd HH:mm:ss",
"protocolCode": "",
"upConfigs": [
{
"id": 0,
"sort": 0,
"protocolApiCode": "",
"protocolAttrField": "",
"remark": "",
"position": "",
"length": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"attrName": "",
"dataType": "",
"attrRemark": "",
"fieldType": "status",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"extra": {
"object": "any object"
}
}
]
}
],
"downConfigs": [
{
"id": 0,
"sort": 0,
"protocolApiCode": "",
"protocolAttrField": "",
"remark": "",
"position": "",
"length": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"attrName": "",
"dataType": "",
"attrRemark": "",
"fieldType": "status",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"extra": {
"object": "any object"
}
}
]
}
]
}
],
"eventApis": [
{
"id": 0,
"type": "func",
"triggerMode": "active",
"code": "",
"name": "",
"status": "",
"remark": "",
"funcType": "R",
"createTime": "yyyy-MM-dd HH:mm:ss",
"protocolCode": "",
"upConfigs": [
{
"id": 0,
"sort": 0,
"protocolApiCode": "",
"protocolAttrField": "",
"remark": "",
"position": "",
"length": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"attrName": "",
"dataType": "",
"attrRemark": "",
"fieldType": "status",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"extra": {
"object": "any object"
}
}
]
}
],
"downConfigs": [
{
"id": 0,
"sort": 0,
"protocolApiCode": "",
"protocolAttrField": "",
"remark": "",
"position": "",
"length": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"attrName": "",
"dataType": "",
"attrRemark": "",
"fieldType": "status",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"extra": {
"object": "any object"
}
}
]
}
]
}
]
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/protocol/detail?id=0&=iq0zih'2.29.8. 协议实现方式列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 协议实现方式列表
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─disabled | boolean | 是否禁用 | - |
└─checked | boolean | 是否默认选中 | - |
└─children | array | 子项 | - |
└─extra | object | 额外扩展信息 | - |
└─selectable | boolean | 可选中 | - |
└─checkable | boolean | 复选框是否能被选中 | - |
└─config | map | 配置项 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"label": "",
"value": {
"object": "any object"
},
"disabled": true,
"checked": true,
"children": [
{
"$ref": ".."
}
],
"extra": {
"object": "any object"
},
"selectable": true,
"checkable": true,
"config": {
"mapKey": {}
}
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/protocol/implModes'2.29.9. 操控方式列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 操控方式列表
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─disabled | boolean | 是否禁用 | - |
└─checked | boolean | 是否默认选中 | - |
└─children | array | 子项 | - |
└─extra | object | 额外扩展信息 | - |
└─selectable | boolean | 可选中 | - |
└─checkable | boolean | 复选框是否能被选中 | - |
└─config | map | 配置项 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"label": "",
"value": {
"object": "any object"
},
"disabled": true,
"checked": true,
"children": [
{
"$ref": ".."
}
],
"extra": {
"object": "any object"
},
"selectable": true,
"checkable": true,
"config": {
"mapKey": {}
}
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/protocol/ctrlModes'2.29.10. 获取协议对应的api列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取协议对应的api列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | 协议id | ||
type | enum | false | func(功能) |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─type | enum | 接口类型 | - |
└─triggerMode | enum | 事件触发方式 | - |
└─code | string | 接口代码 | - |
└─name | string | 接口名称 | - |
└─status | string | 接口状态 | - |
└─remark | string | 接口说明 | - |
└─funcType | enum | 功能类型 | - |
└─createTime | string | 创建时间 | - |
└─protocolCode | string | 所属协议 | - |
└─upConfigs | array | 接口上行配置列表 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─protocolApiCode | string | 所属api接口 | - |
└─protocolAttrField | string | 协议属性 | - |
└─remark | string | 备注 | - |
└─position | string | 点位地址 | - |
└─length | int32 | 配置长度 | - |
└─createTime | string | 创建时间 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─attrRemark | string | 属性说明 | - |
└─fieldType | enum | 字段类型 | - |
└─options | array | 下拉款配置项 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─extra | object | 额外扩展信息 | - |
└─downConfigs | array | 接口下行配置列表 | - |
└─id | int64 | No comments found. | - |
└─sort | int32 | 排序 | - |
└─protocolApiCode | string | 所属api接口 | - |
└─protocolAttrField | string | 协议属性 | - |
└─remark | string | 备注 | - |
└─position | string | 点位地址 | - |
└─length | int32 | 配置长度 | - |
└─createTime | string | 创建时间 | - |
└─attrName | string | 属性名称 | - |
└─dataType | string | 属性类型 | - |
└─attrRemark | string | 属性说明 | - |
└─fieldType | enum | 字段类型 | - |
└─options | array | 下拉款配置项 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─extra | object | 额外扩展信息 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"type": "func",
"triggerMode": "active",
"code": "",
"name": "",
"status": "",
"remark": "",
"funcType": "R",
"createTime": "yyyy-MM-dd HH:mm:ss",
"protocolCode": "",
"upConfigs": [
{
"id": 0,
"sort": 0,
"protocolApiCode": "",
"protocolAttrField": "",
"remark": "",
"position": "",
"length": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"attrName": "",
"dataType": "",
"attrRemark": "",
"fieldType": "status",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"extra": {
"object": "any object"
}
}
]
}
],
"downConfigs": [
{
"id": 0,
"sort": 0,
"protocolApiCode": "",
"protocolAttrField": "",
"remark": "",
"position": "",
"length": 0,
"createTime": "yyyy-MM-dd HH:mm:ss",
"attrName": "",
"dataType": "",
"attrRemark": "",
"fieldType": "status",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"extra": {
"object": "any object"
}
}
]
}
]
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/protocol/apis?id=0&type=func&=umx4cm'2.29.11. 系统内置协议列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 系统内置协议列表
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─disabled | boolean | 是否禁用 | - |
└─checked | boolean | 是否默认选中 | - |
└─children | array | 子项 | - |
└─extra | object | 额外扩展信息 | - |
└─selectable | boolean | 可选中 | - |
└─checkable | boolean | 复选框是否能被选中 | - |
└─config | map | 配置项 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"label": "",
"value": {
"object": "any object"
},
"disabled": true,
"checked": true,
"children": [
{
"$ref": ".."
}
],
"extra": {
"object": "any object"
},
"selectable": true,
"checkable": true,
"config": {
"mapKey": {}
}
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/protocol/internals'2.29.12. 获取产品对应协议的额外配置列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取产品对应协议的额外配置列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
productId | int64 | false | 产品id | ||
type | string | false | 可选值(gateway、network) |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─field | string | 字段名 | - |
└─label | string | 字段说明 | - |
└─extra | string | 额外说明 | - |
└─type | string | 值类型(string, number, hidden) | - |
└─required | boolean | 是否必填 | - |
└─defaultValue | object | 默认值 | - |
└─placeholder | string | No comments found. | - |
└─options | array | 配置值 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─disabled | boolean | 是否禁用 | - |
└─checked | boolean | 是否默认选中 | - |
└─children | array | 子项 | - |
└─extra | object | 额外扩展信息 | - |
└─selectable | boolean | 可选中 | - |
└─checkable | boolean | 复选框是否能被选中 | - |
└─config | map | 配置项 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"field": "",
"label": "",
"extra": "",
"type": "",
"required": true,
"defaultValue": {
"object": "any object"
},
"placeholder": "",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"disabled": true,
"checked": true,
"children": [
{
"$ref": ".."
}
],
"extra": {
"object": "any object"
},
"selectable": true,
"checkable": true,
"config": {
"mapKey": {}
}
}
]
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/protocol/listProtocolConfigByProductId?productId=0&=uie8hv'2.29.13. 获取协议额外配置列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取协议额外配置列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
protocolCode | string | false | 协议代码 | ||
type | string | false | 可选值(gateway、network) |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─field | string | 字段名 | - |
└─label | string | 字段说明 | - |
└─extra | string | 额外说明 | - |
└─type | string | 值类型(string, number, hidden) | - |
└─required | boolean | 是否必填 | - |
└─defaultValue | object | 默认值 | - |
└─placeholder | string | No comments found. | - |
└─options | array | 配置值 | - |
└─label | string | 标签 | - |
└─value | object | 值 | - |
└─disabled | boolean | 是否禁用 | - |
└─checked | boolean | 是否默认选中 | - |
└─children | array | 子项 | - |
└─extra | object | 额外扩展信息 | - |
└─selectable | boolean | 可选中 | - |
└─checkable | boolean | 复选框是否能被选中 | - |
└─config | map | 配置项 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"field": "",
"label": "",
"extra": "",
"type": "",
"required": true,
"defaultValue": {
"object": "any object"
},
"placeholder": "",
"options": [
{
"label": "",
"value": {
"object": "any object"
},
"disabled": true,
"checked": true,
"children": [
{
"$ref": ".."
}
],
"extra": {
"object": "any object"
},
"selectable": true,
"checkable": true,
"config": {
"mapKey": {}
}
}
]
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/protocol/listProtocolConfig?=d3q1z8'2.30. 实时数据管理
2.30.1. 获取指定设备下面的所有事件或者点位数据
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取指定设备下面的所有事件或者点位数据
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
deviceId | int64 | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─mapKey | object | A map key. | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"mapKey": {
"waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
}
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/realtime/listByDeviceId?deviceId=0&=dmdtfu'2.30.2. 获取指定设备下面的所有事件或者点位数据
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取指定设备下面的所有事件或者点位数据
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
productCode | string | false | No comments found. | ||
deviceSn | string | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─mapKey | object | A map key. | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"mapKey": {
"waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
}
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/realtime/listByDevice?=gmyjrl'2.30.3. 获取指定设备点位或者字段实时数据
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取指定设备点位或者字段实时数据
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
productCode | string | false | No comments found. | ||
deviceSn | string | false | No comments found. | ||
eventOrSignalField | string | false | 事件代码或者点位字段 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─prev | object | 上一条记录 | - |
└─id | int64 | 属性或信号id | - |
└─value | object | 值 | - |
└─address | string | 点位地址 | - |
└─collectTime | string | 采集时间 | - |
└─signalOrField | string | 点位或者字段 值必须在同一个{@link DeviceKey}下唯一 | - |
└─status | enum | 采集状态 | - |
└─realtime | object | 实时数据 | - |
└─id | int64 | 属性或信号id | - |
└─value | object | 值 | - |
└─address | string | 点位地址 | - |
└─collectTime | string | 采集时间 | - |
└─signalOrField | string | 点位或者字段 值必须在同一个{@link DeviceKey}下唯一 | - |
└─status | enum | 采集状态 | - |
└─signalOrField | string | 点位地址或者字段名 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"prev": {
"id": 0,
"value": {
"object": "any object"
},
"address": "",
"collectTime": "yyyy-MM-dd HH:mm:ss",
"signalOrField": "",
"status": "Success"
},
"realtime": {
"id": 0,
"value": {
"object": "any object"
},
"address": "",
"collectTime": "yyyy-MM-dd HH:mm:ss",
"signalOrField": "",
"status": "Success"
},
"signalOrField": ""
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/realtime/get?=xl1u74'2.30.4. 获取指定设备下某个事件或者点位字段的实时数据
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取指定设备下某个事件或者点位字段的实时数据
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
deviceId | int64 | false | No comments found. | ||
signalOrField | string | false | 事件代码或者点位字段 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─prev | object | 上一条记录 | - |
└─id | int64 | 属性或信号id | - |
└─value | object | 值 | - |
└─address | string | 点位地址 | - |
└─collectTime | string | 采集时间 | - |
└─signalOrField | string | 点位或者字段 值必须在同一个{@link DeviceKey}下唯一 | - |
└─status | enum | 采集状态 | - |
└─realtime | object | 实时数据 | - |
└─id | int64 | 属性或信号id | - |
└─value | object | 值 | - |
└─address | string | 点位地址 | - |
└─collectTime | string | 采集时间 | - |
└─signalOrField | string | 点位或者字段 值必须在同一个{@link DeviceKey}下唯一 | - |
└─status | enum | 采集状态 | - |
└─signalOrField | string | 点位地址或者字段名 | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"prev": {
"id": 0,
"value": {
"object": "any object"
},
"address": "",
"collectTime": "yyyy-MM-dd HH:mm:ss",
"signalOrField": "",
"status": "Success"
},
"realtime": {
"id": 0,
"value": {
"object": "any object"
},
"address": "",
"collectTime": "yyyy-MM-dd HH:mm:ss",
"signalOrField": "",
"status": "Success"
},
"signalOrField": ""
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/realtime/getByDeviceId?deviceId=0&=6rf4er'2.31. 寄存器点位管理
2.31.1. 列表查询
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 列表查询
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
size | int64 | false | No comments found. | ||
current | int64 | false | No comments found. | ||
id | int64 | false | No comments found. | ||
name | string | false | 点位名称 | ||
address | string | false | 点位地址 | ||
type | int32 | false | 信号类型(1. 点位 2. 自定义报文) | ||
num | int32 | false | 读取的寄存器数量 | ||
message | string | false | 自定义报文 | ||
encode | string | false | 报文编码(HEX, UTF8, ASCII) | ||
productId | int64 | false | 所属产品 | ||
fieldName | string | false | 点位字段名称(同一个产品下的字段唯一) | ||
direct | string | false | 协议指令 | ||
createTime | string | false | No comments found. | ||
protocolId | int64 | false | 所属协议 | ||
directName | string | false | 指令名称 | ||
productName | string | false | 产品明此 | ||
productTypeId | int64 | false | 产品类型id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─size | int64 | No comments found. | - |
└─total | int64 | No comments found. | - |
└─searchCount | boolean | No comments found. | - |
└─current | int64 | No comments found. | - |
└─records | array | No comments found. | - |
└─id | int64 | No comments found. | - |
└─name | string | 点位名称 | - |
└─address | string | 点位地址 | - |
└─type | int32 | 信号类型(1. 点位 2. 自定义报文) | - |
└─num | int32 | 读取的寄存器数量 | - |
└─message | string | 自定义报文 | - |
└─encode | string | 报文编码(HEX, UTF8, ASCII) | - |
└─productId | int64 | 所属产品 | - |
└─fieldName | string | 点位字段名称(同一个产品下的字段唯一) | - |
└─direct | string | 协议指令 | - |
└─createTime | string | No comments found. | - |
└─protocolId | int64 | 所属协议 | - |
└─directName | string | 指令名称 | - |
└─productName | string | 产品明此 | - |
└─productTypeId | int64 | 产品类型id | - |
└─hitCount | boolean | No comments found. | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"size": 0,
"total": 0,
"searchCount": true,
"current": 0,
"records": [
{
"id": 0,
"name": "",
"address": "",
"type": 0,
"num": 0,
"message": "",
"encode": "",
"productId": 0,
"fieldName": "",
"direct": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"protocolId": 0,
"directName": "",
"productName": "",
"productTypeId": 0
}
],
"hitCount": true
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/signal/view?size=0¤t=0&id=0&type=0&num=0&productId=0&createTime=yyyy-MM-dd HH:mm:ss&protocolId=0&productTypeId=0&records[0].name=&records[0].encode=&encode=&records[0].directName=&records[0].productTypeId=0&orders[0].address=&message=&fieldName=&orders[0].name=&address=&orders[0].message=&records[0].createTime=yyyy-MM-dd HH:mm:ss&orders[0].num=0&productName=&orders[0].productId=0&orders[0].encode=&orders[0].type=0&records[0].type=0&records[0].fieldName=&orders[0].createTime=yyyy-MM-dd HH:mm:ss&orders[0].productName=&optimizeCountSql=true&records[0].message=&records[0].productId=0&records[0].protocolId=0&countId=&hitCount=true&orders[0].id=0&records[0].direct=&orders[0].productTypeId=0&records[0].address=&records[0].productName=&direct=&orders[0].protocolId=0&records[0].num=0&pages=0&records[0].id=0&orders[0].directName=&isSearchCount=true&orders[0].direct=&total=0&orders[0].fieldName=&name=&maxLimit=0&directName='2.31.2. 获取指定产品下面的点位列表
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取指定产品下面的点位列表
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
productIds | array | false | 产品列表,[array of int64] | ||
name | string | false | 点位名 |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | array | 响应实体 | - |
└─id | string | No comments found. | - |
└─name | string | 点位名称 | - |
└─address | string | 点位地址 | - |
└─fieldName | string | 点位字段名称 | - |
└─productName | string | 产品名称 | - |
Response-example:
{
"code": 0,
"message": "",
"data": [
{
"id": "",
"name": "",
"address": "",
"fieldName": "",
"productName": ""
}
]
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/signal/listByProductIds?productIds=wx6i6j&productIds=wx6i6j&=h3fe6i'2.31.3. 获取编辑记录
Type: GET
Author: iteaj
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取编辑记录
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
id | int64 | false | 记录id |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | object | 响应实体 | - |
└─id | int64 | No comments found. | - |
└─name | string | 点位名称 | - |
└─address | string | 点位地址 | - |
└─type | int32 | 信号类型(1. 点位 2. 自定义报文) | - |
└─num | int32 | 读取的寄存器数量 | - |
└─message | string | 自定义报文 | - |
└─encode | string | 报文编码(HEX, UTF8, ASCII) | - |
└─productId | int64 | 所属产品 | - |
└─fieldName | string | 点位字段名称(同一个产品下的字段唯一) | - |
└─direct | string | 协议指令 | - |
└─createTime | string | No comments found. | - |
└─protocolId | int64 | 所属协议 | - |
└─directName | string | 指令名称 | - |
└─productName | string | 产品明此 | - |
└─productTypeId | int64 | 产品类型id | - |
Response-example:
{
"code": 0,
"message": "",
"data": {
"id": 0,
"name": "",
"address": "",
"type": 0,
"num": 0,
"message": "",
"encode": "",
"productId": 0,
"fieldName": "",
"direct": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"protocolId": 0,
"directName": "",
"productName": "",
"productTypeId": 0
}
}Curl-example:
curl -X GET -i 'http://127.0.0.1:8085/api/iot/signal/edit?id=0&=im85j1'2.31.4. 新增或者更新记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 新增或者更新记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | false | No comments found. |
name | string | false | 点位名称 |
address | string | false | 点位地址 |
type | int32 | false | 信号类型(1. 点位 2. 自定义报文) |
num | int32 | false | 读取的寄存器数量 |
message | string | false | 自定义报文 |
encode | string | false | 报文编码(HEX, UTF8, ASCII) |
productId | int64 | false | 所属产品 |
fieldName | string | false | 点位字段名称(同一个产品下的字段唯一) |
direct | string | false | 协议指令 |
createTime | string | false | No comments found. |
protocolId | int64 | false | 所属协议 |
directName | string | false | 指令名称 |
productName | string | false | 产品明此 |
productTypeId | int64 | false | 产品类型id |
Request-body:
{
"id": 0,
"name": "",
"address": "",
"type": 0,
"num": 0,
"message": "",
"encode": "",
"productId": 0,
"fieldName": "",
"direct": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"protocolId": 0,
"directName": "",
"productName": "",
"productTypeId": 0
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/signal/saveOrUpdate' --data '{
"id": 0,
"name": "",
"address": "",
"type": 0,
"num": 0,
"message": "",
"encode": "",
"productId": 0,
"fieldName": "",
"direct": "",
"createTime": "yyyy-MM-dd HH:mm:ss",
"protocolId": 0,
"directName": "",
"productName": "",
"productTypeId": 0
}'2.31.5. 删除指定记录
Type: POST
Author: iteaj
Content-Type: application/json
Description: 删除指定记录
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
idList | array | false | No comments found.,[array of int64] |
Request-body:
[
0
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
code | int64 | 错误码 | - |
message | string | 错误描述 | - |
data | boolean | 响应实体 | - |
Response-example:
{
"code": 0,
"message": "",
"data": true
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i 'http://127.0.0.1:8085/api/iot/signal/del' --data '[
0
]'